From f1cae15bc0725a9600b5d99c446b73d63023b4f2 Mon Sep 17 00:00:00 2001 From: thinkerou Date: Sun, 25 Dec 2022 11:48:17 +0800 Subject: [PATCH] update readme --- README.md | 8 ++++++-- docs/doc.md | 11 +++++++---- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 897a6ce8..64a304de 100644 --- a/README.md +++ b/README.md @@ -80,9 +80,13 @@ And use the Go command to run the demo: $ 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. diff --git a/docs/doc.md b/docs/doc.md index a312d891..008a91db 100644 --- a/docs/doc.md +++ b/docs/doc.md @@ -2,8 +2,9 @@ ## Contents -- [Build with json replacement](#build-with-json-replacement) -- [Build without `MsgPack` rendering feature](#build-without-msgpack-rendering-feature) +- [Build Tags](#build-tags) + - [Build with json replacement](#build-with-json-replacement) + - [Build without `MsgPack` rendering feature](#build-without-msgpack-rendering-feature) - [API Examples](#api-examples) - [Using GET, POST, PUT, PATCH, DELETE and OPTIONS](#using-get-post-put-patch-delete-and-options) - [Parameters in path](#parameters-in-path) @@ -62,7 +63,9 @@ - [Don't trust all proxies](#dont-trust-all-proxies) - [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. @@ -84,7 +87,7 @@ go build -tags=go_json . $ 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.