Add note about nomsgpack tag to the readme (#2703)

Co-authored-by: Bo-Yi Wu <appleboy.tw@gmail.com>
This commit is contained in:
y-yagi 2021-05-01 15:13:50 +09:00 committed by GitHub
parent 1acb459c10
commit 5452a1d3ef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -24,6 +24,7 @@ Gin is a web framework written in Go (Golang). It features a martini-like API wi
- [Benchmarks](#benchmarks) - [Benchmarks](#benchmarks)
- [Gin v1. stable](#gin-v1-stable) - [Gin v1. stable](#gin-v1-stable)
- [Build with jsoniter/go-json](#build-with-json-replacement) - [Build with jsoniter/go-json](#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)
@ -195,6 +196,16 @@ $ go build -tags=jsoniter .
$ go build -tags=go_json . $ go build -tags=go_json .
``` ```
## Build without `MsgPack` rendering feature
Gin enables `MsgPack` rendering feature by default. But you can disable this feature by specifying `nomsgpack` build tag.
```sh
$ go build -tags=nomsgpack .
```
This is useful to reduce the binary size of executable files. See the [detail information](https://github.com/gin-gonic/gin/pull/1852).
## API Examples ## API Examples
You can find a number of ready-to-run examples at [Gin examples repository](https://github.com/gin-gonic/examples). You can find a number of ready-to-run examples at [Gin examples repository](https://github.com/gin-gonic/examples).