Pārlūkot izejas kodu

update readme for relase v1.0

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
Bo-Yi Wu 9 gadi atpakaļ
vecāks
revīzija
764baefb88
2 mainītis faili ar 16 papildinājumiem un 2 dzēšanām
  1. 15 1
      README.md
  2. 1 1
      examples/example.go

+ 15 - 1
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"
 )
 

+ 1 - 1
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"
 )