From 764baefb889e2d3b0b22e33d85248da2718cc58d Mon Sep 17 00:00:00 2001 From: Bo-Yi Wu Date: Mon, 31 Oct 2016 16:19:39 +0800 Subject: [PATCH] update readme for relase v1.0 Signed-off-by: Bo-Yi Wu --- README.md | 16 +++++++++++++++- examples/example.go | 2 +- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 93c7bb7..8e643d1 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,20 @@ Gin middleware/handler to enable CORS support. ## Usage +### Start using it + +1. Download and install it: + +```sh +$ go get gopkg.in/gin-contrib/cors.v1 +``` + +2. Import it in your code: + +```go +import "gopkg.in/gin-contrib/cors.v1" +``` + ### Canonical example: ```go @@ -19,7 +33,7 @@ package main import ( "time" - "github.com/gin-contrib/cors" + "gopkg.in/gin-contrib/cors.v1" "gopkg.in/gin-gonic/gin.v1" ) diff --git a/examples/example.go b/examples/example.go index 99dc232..114c49a 100644 --- a/examples/example.go +++ b/examples/example.go @@ -3,7 +3,7 @@ package main import ( "time" - "github.com/gin-contrib/cors" + "gopkg.in/gin-contrib/cors.v1" "gopkg.in/gin-gonic/gin.v1" )