Merge pull request #182 from atc-net/feature/updating_documentation

docs: Updating README.md

Author: perkops

Diff for: README.md

@@ -23,21 +23,22 @@
 
 ## Projects in the repository
 
-|Project|Target Framework|Description|Docs|Nuget Download Link|
-|---|---|---|---|---|
-|[Atc.Rest.ApiGenerator](src/Atc.Rest.ApiGenerator)|net6.0|Atc.Rest.ApiGenerator is a WebApi C# code generator using a OpenApi 3.0.x specification YAML file.|[References](docs/CodeDoc/Atc.Rest.ApiGenerator/Index.md)<br/>[References extended](docs/CodeDoc/Atc.Rest.ApiGenerator/IndexExtended.md)|[![Nuget](https://img.shields.io/nuget/dt/Atc.Rest.ApiGenerator?logo=nuget&style=flat-square)](https://www.nuget.org/packages/Atc.Rest.ApiGenerator)|
-|[Atc.Rest.ApiGenerator.CLI](src/Atc.Rest.ApiGenerator.CLI)|net6.0|A CLI tool that use Atc.Rest.ApiGenerator to create/update a project specified by a OpenApi 3.0.x specification YAML file.||[![Nuget](https://img.shields.io/nuget/dt/atc-rest-api-generator?logo=nuget&style=flat-square)](https://www.nuget.org/packages/atc-rest-api-generator)|
+|Project|Target Framework|Description|Nuget Download Link|
+|---|---|---|---|
+|[Atc.Rest.ApiGenerator](src/Atc.Rest.ApiGenerator)|net6.0|Atc.Rest.ApiGenerator is a WebApi C# code generator using a OpenApi 3.0.x specification YAML file.|[![Nuget](https://img.shields.io/nuget/dt/Atc.Rest.ApiGenerator?logo=nuget&style=flat-square)](https://www.nuget.org/packages/Atc.Rest.ApiGenerator)|
+|[Atc.Rest.ApiGenerator.CLI](src/Atc.Rest.ApiGenerator.CLI)|net6.0|A CLI tool that use Atc.Rest.ApiGenerator to create/update a project specified by a OpenApi 3.0.x specification YAML file.|[![Nuget](https://img.shields.io/nuget/dt/atc-rest-api-generator?logo=nuget&style=flat-square)](https://www.nuget.org/packages/atc-rest-api-generator)|
 
 ## CLI Tool
 
 The `atc-rest-api-generator` is a cross platform command line application known as CLI tool.
 
-The main purpose of this application is to create and maintain a REST-API service based on an Open-API specification file. So the consept is the `Design First` approse.
-And the `atc-rest-api-generator` should be categorized as a `Rapid Application Development Tool` for REST-API in .NET/C#.
+The main purpose of this application is to create and maintain a REST-API based on an Open-API specification file using a `Design First` approach.
+
+The `atc-rest-api-generator` can be categorized as a `Rapid Application Development Tool` for REST-API in .NET/C#.
 
 ## Prerequisites
 
-To get the benefit out of this CLI tool, a `Design first approach` of the REST API in a `OpenAPI specification` should be made. The CLI tool needs at least a `OpenAPI specification` in a `yaml` or `json` file format, to work with as argument value for parameter `--specificationPath` or the short-version `-s`.
+To get the benefit out of this CLI tool, a `Design first` approach of the REST API in a `OpenAPI specification` should be in effect. The CLI tool needs a `OpenAPI specification` in `yaml` or `json` file format provided as the argument value for parameter `--specificationPath` or the short-hand-version `-s`.
 
 Read more about REST API design in [ATC DevOps Playbook](https://atc-net.github.io/manuals/devops-playbook#rest-api-design).
 
@@ -198,6 +199,19 @@ atc-rest-api-generator generate server all `
     -v
 ```
 
+The following is generated by running the above command:
+
+```mermaid
+flowchart TB;
+    CMD[command: generate server all] --> HOST[Host project] & API[API project] & DOMAIN[Domain project];
+    HOST-.-> API;
+    API-.-> DOMAIN;
+```
+
+- The Host-project is the layer for the `.NET WebApi` application. Project suffix: `.Api`.
+- The API-project is the layer with all the contracts, interfaces, result classes and endpoints. Project suffix: `.Api.Generated`.
+- The Domain-project is the layer where handlers can be implemented with necessary business logic. Project suffix: `.Domain`.
+
 Running the above command produces the following output:
 
 ```powershell
@@ -291,26 +305,13 @@ Running the above command produces the following output:
 ✅ Done
 ```
 
-After the generator is finished running, the API can be started by running the following command:
+After the generator finishes running, the API can be started by executing the following command:
 
 ```powershell
 dotnet run --project C:\PetStore\src\PetStore.Api
 ```
 
-And then open a browser with url: [https://localhost:5001/swagger](https://localhost:5001/swagger)
-
-The following is generated by running the above command:
-
-```mermaid
-flowchart TB;
-    CMD[command: generate server all] --> HOST[Host project] & API[API project] &  DOMAIN[Domain project];
-    HOST-.-> API;
-    API-.-> DOMAIN;
-```
-
-- The Host-project is the layer for the `.NET WebApi` application. Project suffix: `.Api`.
-- The API-project is the layer with all the contracts, interfaces, result classes and endpoints. Project suffix: `.Api.Generated`.
-- The Domain-project is the layer where handlers can be implemented with necessary business logic. Project suffix: `.Domain`.
+And then open a browser and navigate to the url: [https://localhost:5001/swagger](https://localhost:5001/swagger)
 
 ## Security - supporting role-based security and custom authentication-schemes