blackteay/gin
3
0
Fork 0
mirror of https://github.com/gin-gonic/gin.git synced 2025-10-17 05:42:09 +08:00
Code Issues Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
thinkerou 2022-12-25 11:48:17 +08:00
parent 77891feabd
commit f1cae15bc0
2 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -80,9 +80,13 @@ And use the Go command to run the demo:
$ go run example.go $ go run example.go
``` ```
For more examples, please read the [Gin Quick Start](docs/doc.md). ### Learn more examples
## Examples #### Quick Start
Learn and practice more examples, please read the [Gin Quick Start](docs/doc.md) which includes API examples and builds tag.
#### Examples
A number of ready-to-run examples demonstrating various use cases of Gin on the [Gin examples](https://github.com/gin-gonic/examples) repository. A number of ready-to-run examples demonstrating various use cases of Gin on the [Gin examples](https://github.com/gin-gonic/examples) repository.

11
docs/doc.md
View File

@ -2,8 +2,9 @@
## Contents ## Contents
- [Build with json replacement](#build-with-json-replacement) - [Build Tags](#build-tags)
- [Build without `MsgPack` rendering feature](#build-without-msgpack-rendering-feature) - [Build with json replacement](#build-with-json-replacement)
- [Build without `MsgPack` rendering feature](#build-without-msgpack-rendering-feature)
- [API Examples](#api-examples) - [API Examples](#api-examples)
- [Using GET, POST, PUT, PATCH, DELETE and OPTIONS](#using-get-post-put-patch-delete-and-options) - [Using GET, POST, PUT, PATCH, DELETE and OPTIONS](#using-get-post-put-patch-delete-and-options)
- [Parameters in path](#parameters-in-path) - [Parameters in path](#parameters-in-path)
@ -62,7 +63,9 @@
- [Don't trust all proxies](#dont-trust-all-proxies) - [Don't trust all proxies](#dont-trust-all-proxies)
- [Testing](#testing) - [Testing](#testing)
## Build with json replacement ## Build tags
### Build with json replacement
Gin uses `encoding/json` as default json package but you can change it by build from other tags. Gin uses `encoding/json` as default json package but you can change it by build from other tags.
@ -84,7 +87,7 @@ go build -tags=go_json .
$ go build -tags="sonic avx" . $ go build -tags="sonic avx" .
``` ```
## Build without `MsgPack` rendering feature ### Build without `MsgPack` rendering feature
Gin enables `MsgPack` rendering feature by default. But you can disable this feature by specifying `nomsgpack` build tag. Gin enables `MsgPack` rendering feature by default. But you can disable this feature by specifying `nomsgpack` build tag.