Skip to content

Commit

Permalink
Add note about nomsgpack tag to the readme (#2703)
Browse files Browse the repository at this point in the history
Co-authored-by: Bo-Yi Wu <appleboy.tw@gmail.com>
  • Loading branch information
y-yagi and appleboy committed May 1, 2021
1 parent 1acb459 commit 5452a1d
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Expand Up @@ -24,6 +24,7 @@ Gin is a web framework written in Go (Golang). It features a martini-like API wi
- [Benchmarks](#benchmarks)
- [Gin v1. stable](#gin-v1-stable)
- [Build with jsoniter/go-json](#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)
Expand Down Expand Up @@ -195,6 +196,16 @@ $ go build -tags=jsoniter .
$ 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

You can find a number of ready-to-run examples at [Gin examples repository](https://github.com/gin-gonic/examples).
Expand Down

0 comments on commit 5452a1d

Please sign in to comment.