diff --git a/README.md b/README.md index 2ce6e9e..2294950 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