Skip to content

Update README to match Godel Opensource standard #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
akryshtafovichgodel wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update README to match Godel Opensource standard #35

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f3efeb2
Updated README to match Godel Opensource standard
akryshtafovichgodel Dec 15, 2024
25f69cc
Apply suggestions from code review
akryshtafovichgodel Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -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.
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.