blackteay/gin
3
0
Fork 0
mirror of https://github.com/gin-gonic/gin.git synced 2026-01-11 00:56:57 +08:00
Code Issues Projects Releases Wiki Activity

Update ReadMe to reflect develop branch changes

Browse Source 
Updated ReadMe to clarify and correct how to use develop branch of Gin .
This commit is contained in:
David Bainbridge 2017-04-18 13:13:31 -05:00 committed by GitHub
parent 957f6205c8
commit 0a384832da
1 changed files with 6 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -13,7 +13,7 @@ $ cat test.go
```go
package main
import "gopkg.in/gin-gonic/gin.v1"
import "github.com/gin-gonic/gin"
func main() {
r := gin.Default()
@ -68,7 +68,7 @@ BenchmarkZeus_GithubAll | 2000 | 944234 | 300688 | 2648
(3): Heap Memory (B/op)
(4): Average Allocations per Repetition (allocs/op)
## Gin v1. stable
## Gin v1.2 develop
- [x] Zero allocation router.
- [x] Still the fastest http router and framework. From routing to writing.
@ -78,17 +78,18 @@ BenchmarkZeus_GithubAll | 2000 | 944234 | 300688 | 2648
## Start using it
Note: [govendor](https://github.com/kardianos/govendor) is used by Gin for dependency management.
1. Download and install it:
1. Download and install Gin:
```sh
$ go get gopkg.in/gin-gonic/gin.v1
$ govendor fetch github.com/gin-gonic/gin@=develop
```
2. Import it in your code:
```go
import "gopkg.in/gin-gonic/gin.v1"
import "github.com/gin-gonic/gin"
```
3. (Optional) Import `net/http`. This is required for example if using constants such as `http.StatusOK`.
@ -97,14 +98,6 @@ import "gopkg.in/gin-gonic/gin.v1"
import "net/http"
```
4. (Optional) Use latest changes (note: they may be broken and/or unstable):
```sh
$ GIN_PATH=$GOPATH/src/gopkg.in/gin-gonic/gin.v1
$ git -C $GIN_PATH checkout develop
$ git -C $GIN_PATH pull origin develop
```
## API Examples
### Using GET, POST, PUT, PATCH, DELETE and OPTIONS