vinchent/gin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Changed imports to gopkg instead of github in README (#733)

Browse Source 
* Add contribution guide

* Update go get for stable version

In the future, github default branch will be develop so running `go get github.com/gin-gonic/gin` will pull latest code from develop.

* Changed imports to gopkg instead of github in README

* Update README.md
This commit is contained in:
Pablo Moncada 2016-11-08 18:38:28 +01:00 committed by Javier Provecho Fernandez
parent 3ad4c714a7
commit 9177f01c28
1 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -18,7 +18,7 @@ $ cat test.go
```go ```go
package main package main
import "github.com/gin-gonic/gin" import "gopkg.in/gin-gonic/gin.v1"
func main() { func main() {
r := gin.Default() r := gin.Default()
@ -87,13 +87,13 @@ BenchmarkZeus_GithubAll | 2000 | 944234 | 300688 | 2648
1. Download and install it: 1. Download and install it:
```sh ```sh
$ go get github.com/gin-gonic/gin $ go get gopkg.in/gin-gonic/gin.v1
``` ```
2. Import it in your code: 2. Import it in your code:
```go ```go
import "github.com/gin-gonic/gin" import "gopkg.in/gin-gonic/gin.v1"
``` ```
3. (Optional) Import `net/http`. This is required for example if using constants such as `http.StatusOK`. 3. (Optional) Import `net/http`. This is required for example if using constants such as `http.StatusOK`.
@ -377,8 +377,7 @@ func main() {
package main package main
import ( import (
"github.com/gin-gonic/gin" "gopkg.in/gin-gonic/gin.v1"
"github.com/gin-gonic/gin/binding"
) )
type LoginForm struct { type LoginForm struct {
@ -713,6 +712,19 @@ An alternative to endless:
* [manners](https://github.com/braintree/manners): A polite Go HTTP server that shuts down gracefully. * [manners](https://github.com/braintree/manners): A polite Go HTTP server that shuts down gracefully.
## Contributing
- With issues:
- Use the search tool before opening a new issue.
- Please provide source code and commit sha if you found a bug.
- Review existing issues and provide feedback or react to them.
- With pull requests:
- Open your pull request against develop
- Your pull request should have no more than two commits, if not you should squash them.
- It should pass all tests in the available continuous integrations systems such as TravisCI.
- You should add/modify tests to cover your proposed code changes.
- If your pull request contains a new feature, please document it on the README.
## Example ## Example
Awesome project lists using [Gin](https://github.com/gin-gonic/gin) web framework. Awesome project lists using [Gin](https://github.com/gin-gonic/gin) web framework.