From f3efeb28ca830a977ad2561a90e7b0e2087715ed Mon Sep 17 00:00:00 2001 From: Aleh Kryshtafovich Date: Sun, 15 Dec 2024 21:25:24 +0100 Subject: [PATCH 1/2] Updated README to match Godel Opensource standard --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2ce6e9e..f068846 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,8 @@ # GodelTech.Microservices.Swagger + +# Description +The GodelTech.Microservices.Swagger repository is designed to integrate Swagger into microservices developed using C#. It provides tools and configurations to seamlessly incorporate Swagger documentation and UI into microservices, ensuring that APIs are well-documented and easy to interact with. + ## Overview **GodelTech.Microservices.Swagger** project provides initializer which configures Swagger endpoinds and Swagger UI. Default configuration looks as follows: @@ -65,4 +69,7 @@ Full control over `SwaggerInitializer` can be obtained by defined child class. T ## Links -Current project is Swagger extension of Microservice Framework. You can find references to all available projects in core project of framework [GodelTech.Microservices.Core](https://github.com/GodelTech/GodelTech.Microservices.Core). Extension is based on [Swashbuckle.AspNetCore](https://github.com/domaindrivendev/Swashbuckle.AspNetCore) project. \ No newline at end of file +Current project is Swagger extension of Microservice Framework. You can find references to all available projects in core project of framework [GodelTech.Microservices.Core](https://github.com/GodelTech/GodelTech.Microservices.Core). Extension is based on [Swashbuckle.AspNetCore](https://github.com/domaindrivendev/Swashbuckle.AspNetCore) project. + +# License +This project is licensed under the MIT License. See the LICENSE file for more details. \ No newline at end of file From 25f69cca394b353466e74c78b8b228a8ffcf3cd5 Mon Sep 17 00:00:00 2001 From: Aleh Kryshtafovich Date: Thu, 19 Dec 2024 11:32:01 +0100 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Pavel Novikau --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f068846..2294950 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # GodelTech.Microservices.Swagger -# Description +## Description The GodelTech.Microservices.Swagger repository is designed to integrate Swagger into microservices developed using C#. It provides tools and configurations to seamlessly incorporate Swagger documentation and UI into microservices, ensuring that APIs are well-documented and easy to interact with. ## Overview @@ -71,5 +71,5 @@ Full control over `SwaggerInitializer` can be obtained by defined child class. T Current project is Swagger extension of Microservice Framework. You can find references to all available projects in core project of framework [GodelTech.Microservices.Core](https://github.com/GodelTech/GodelTech.Microservices.Core). Extension is based on [Swashbuckle.AspNetCore](https://github.com/domaindrivendev/Swashbuckle.AspNetCore) project. -# License +## License This project is licensed under the MIT License. See the LICENSE file for more details. \ No newline at end of file