Skip to content

Commit 85198fb

Browse files
committed
Refactor auth and update docs
1 parent 06bb32f commit 85198fb

File tree

1 file changed

+16
-18
lines changed

1 file changed

+16
-18
lines changed

README.md

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545

4646
# Genocs .NET library
4747

48-
This repo contains a set of libraries designed by Genocs. The library is built on top of .NET8.
48+
This repo contains a set of libraries to build LOB (Line Of Business) applications. The library is open source and built to be PRODUCTION READY. The library is built on top of .NET8, it is designed and maintained by Genocs.
4949

5050
Packages are available on [NuGet Genocs](https://www.nuget.org/profiles/gioema_nocco).
5151

@@ -59,10 +59,16 @@ Building a software library to be cloud agnostic has several advantages. First,
5959

6060
The advantages of using containers are numerous. Containers provide a lightweight, portable, and isolated environment for applications to run in, allowing them to be easily moved between different systems. This makes it easier to deploy applications quickly and reliably across different environments. Additionally, containers can help reduce resource consumption by running multiple applications on the same host, as each container is isolated from the others. This helps to improve efficiency and scalability. Finally, containers provide an additional layer of security, as they are isolated from the underlying operating system and other applications.
6161

62+
## Documentation
63+
64+
You can find a useful documentation about how to use the library. The documentation contains the complete set of libraries, template, CLI that altogether make the *genocs ecosystem* a comprensive set of tools to build enterprise solutions.
65+
66+
Documentation available at [Genocs Blog](https://genocs-blog.netlify.app/library/)
67+
6268
## Infrastructure
6369

64-
In this section you can find the infrastructure components to setup the environment.
65-
You will use ***Docker compose*** to setup the infrastructure components.
70+
In this section you can find the infrastructure components you need to execute the solution. Infrastucture components are the database, the enterprice servise bus, the distributed logging, monitoring, tracing systems along with database and many more.
71+
You can use **Docker compose** to setup the infrastructure components just by running few commands.
6672

6773

6874
``` bash
@@ -145,16 +151,8 @@ You can setup the application inside a Kubernetes cluster.
145151
Check the repo [enterprise-containers](https://github.com/Genocs/enterprise-containers) to setup a Kubernetes cluster.
146152
There you can find scripts, configuration files and documentation to setup a cluster from scratch.
147153
148-
## **Libraries**
149-
You can find a full documentation on:
150-
[**Documentation**](https://genocs-blog.netlify.app/library/)
151-
152-
153-
154154
## Support
155155
156-
157-
158156
Use [**api-workbench**](./api-workbench.rest) inside Visual Studio code with [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) plugin
159157
160158
## Configuration
@@ -385,7 +383,8 @@ Use [**api-workbench**](./api-workbench.rest) inside Visual Studio code with [RE
385383
## Demo Application
386384
Inside the library there is a simple demo application you can use to test the library.
387385

388-
Some commands
386+
Following are the commands to build and run the demo application.
387+
389388
``` bash
390389
# Build the solution
391390
dotnet build
@@ -425,13 +424,11 @@ docker build -t genocs/demo-worker:2.0.0 -t genocs/demo-worker:latest -f ./demo-
425424
docker push genocs/demo-worker:2.0.0
426425
docker push genocs/demo-worker:latest
427426
```
428-
429-
---
427+
---
430428

431429
## Enterprise Application
432430

433-
434-
Take a look inside **./src/apps** folder. There you can find a full-fledged application composed by:
431+
Inside **./src/apps** folder you can find a full-fledged application composed by:
435432
- ApiGateway
436433
- Identity Service
437434
- Order Service
@@ -440,6 +437,7 @@ Take a look inside **./src/apps** folder. There you can find a full-fledged appl
440437

441438
In that way you can test the entire flow.
442439

440+
**TODO**: Add a architecture diagram to show the components and how they interact with each other.
443441

444442
### How to BUILD & RUN the application
445443

@@ -509,9 +507,9 @@ You can deploy Demo Application with one click in Heroku, Microsoft Azure, or Go
509507

510508
This project is licensed with the [MIT license](LICENSE).
511509

512-
## Changelogs
510+
## Changelog
513511

514-
View Complete [Changelogs](https://github.com/Genocs/microservice-template/blob/main/CHANGELOGS.md).
512+
View Complete [Changelog](https://github.com/Genocs/microservice-template/blob/main/CHANGELOG.md).
515513

516514
## Community
517515

0 commit comments

Comments
 (0)