From bdb25bb8372faa59ec23cfe3c25dece33e1cd8ec Mon Sep 17 00:00:00 2001
From: Aleem Isiaka <aleemisiaka@gmail.com>
Date: Thu, 7 Sep 2023 12:47:26 +0100
Subject: [PATCH] Add read me support

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/README.md b/README.md
index 7e07033..ff43ee9 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,4 @@
+
 # gin-swagger
 
 gin middleware to automatically generate RESTful API documentation with Swagger 2.0.
@@ -15,43 +16,54 @@ gin middleware to automatically generate RESTful API documentation with Swagger
 1. Add comments to your API source code, [See Declarative Comments Format](https://github.com/swaggo/swag/blob/master/README.md#declarative-comments-format).
 2. Download [Swag](https://github.com/swaggo/swag) for Go by using:
 
+---
 ```sh
 go get -u github.com/swaggo/swag/cmd/swag
 ```
+---
 
 Starting in Go 1.17, installing executables with `go get` is deprecated. `go install` may be used instead:
 
+---
 ```sh
 go install github.com/swaggo/swag/cmd/swag@latest
 ```
+---
 
 3. Run the [Swag](https://github.com/swaggo/swag) at your Go project root path(for instance `~/root/go-project-name`),
    [Swag](https://github.com/swaggo/swag) will parse comments and generate required files(`docs` folder and `docs/doc.go`)
    at `~/root/go-project-name/docs`.
 
+---
 ```sh
 swag init
 ```
+---
 
 4. Download [gin-swagger](https://github.com/swaggo/gin-swagger) by using:
 
+---
 ```sh
 go get -u github.com/swaggo/gin-swagger
 go get -u github.com/swaggo/files
 ```
+---
 
 Import following in your code:
 
+---
 ```go
 import "github.com/swaggo/gin-swagger" // gin-swagger middleware
 import "github.com/swaggo/files" // swagger embed files
 
 ```
+---
 
 ### Canonical example:
 
 Now assume you have implemented a simple api as following:
 
+---
 ```go
 // A get function which returns a hello world string by json
 func Helloworld(g *gin.Context)  {
@@ -59,11 +71,13 @@ func Helloworld(g *gin.Context)  {
 }
 
 ```
+---
 
 So how to use gin-swagger on api above? Just follow the following guide.
 
 1. Add Comments for apis and main function with gin-swagger rules like following:
 
+---
 ```go
 // @BasePath /api/v1
 
@@ -80,21 +94,25 @@ func Helloworld(g *gin.Context)  {
 	g.JSON(http.StatusOK,"helloworld")
 }
 ```
+---
 
 2. Use `swag init` command to generate a docs, docs generated will be stored at `docs/`.
 3. import the docs like this:
    I assume your project named `github.com/go-project-name/docs`.
 
+---
 ```go
 import (
    docs "github.com/go-project-name/docs"
 )
 ```
+---
 
 4. build your application and after that, go to http://localhost:8080/swagger/index.html ,you to see your Swagger UI.
 
 5. The full code and folder relatives here:
 
+---
 ```go
 package main
 
@@ -135,9 +153,11 @@ func main()  {
 
 }
 ```
+---
 
 Demo project tree, `swag init` is run at relative `.`
 
+---
 ```
 .
 ├── docs
@@ -148,6 +168,7 @@ Demo project tree, `swag init` is run at relative `.`
 ├── go.sum
 └── main.go
 ```
+---
 
 ## Multiple APIs
 
@@ -157,6 +178,7 @@ This feature was introduced in swag v1.7.9
 
 You can configure Swagger using different configuration options
 
+---
 ```go
 func main() {
 	r := gin.New()
@@ -168,6 +190,7 @@ func main() {
 	r.Run()
 }
 ```
+---
 
 | Option                   | Type   | Default    | Description                                                                                                                                                                                                                                               |
 | ------------------------ | ------ | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -178,3 +201,4 @@ func main() {
 | InstanceName             | string | "swagger"  | The instance name of the swagger document. If multiple different swagger instances should be deployed on one gin router, ensure that each instance has a unique name (use the _--instanceName_ parameter to generate swagger documents with _swag init_). |
 | PersistAuthorization     | bool   | false      | If set to true, it persists authorization data and it would not be lost on browser close/refresh.                                                                                                                                                         |
 | Oauth2DefaultClientID    | string | ""         | If set, it's used to prepopulate the _client_id_ field of the OAuth2 Authorization dialog.                                                                                                                                                                |
+| SupportedSubmitMethods    | []string | ["get", "put", "post", "delete", "options", "head", "patch", "trace"]         | This controls the methods that has Try It Out buttons. Set the methods to support or pass an empty string slice to support none |