Merge pull request #7 from gin-contrib/new

Updates README
gin-contrib · Oct 31, 2016 · 0202b02 · 0202b02
2 parents 9726988 + 764baef
commit 0202b02
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git 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
@@ -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"
 )