Browse Source

update example.

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
Bo-Yi Wu 9 years ago
parent
commit
4a4ce7ebc1
2 changed files with 43 additions and 2 deletions
  1. 40 0
      README.md
  2. 3 2
      example/example.go

+ 40 - 0
README.md

@@ -9,3 +9,43 @@
 Gin middleware to enable `GZIP` support.
 
 ## Usage
+
+### Start using it
+
+Download and install it:
+
+```sh
+$ go get github.com/gin-contrib/gzip
+```
+
+Import it in your code:
+
+```go
+import "github.com/gin-contrib/gzip"
+```
+
+### Canonical example:
+
+```go
+package main
+
+import (
+	"fmt"
+	"time"
+
+	"github.com/gin-gonic/contrib/gzip"
+	"gopkg.in/gin-gonic/gin.v1"
+)
+
+func main() {
+	r := gin.Default()
+	r.Use(gzip.Gzip(gzip.DefaultCompression))
+	r.GET("/ping", func(c *gin.Context) {
+		c.String(200, "pong "+fmt.Sprint(time.Now().Unix()))
+	})
+
+	// Listen and Server in 0.0.0.0:8080
+	r.Run(":8080")
+}
+
+```

+ 3 - 2
example/example.go

@@ -2,9 +2,10 @@ package main
 
 import (
 	"fmt"
-	"github.com/gin-contrib/gzip"
-	"gopkg.in/gin-gonic/gin.v1"
 	"time"
+
+	"github.com/gin-gonic/contrib/gzip"
+	"gopkg.in/gin-gonic/gin.v1"
 )
 
 func main() {