From cf788af04f2620d45866856e814bae655c81859b Mon Sep 17 00:00:00 2001 From: Bo-Yi Wu Date: Tue, 13 Dec 2016 10:10:13 +0800 Subject: [PATCH] add readme. Signed-off-by: Bo-Yi Wu --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.md b/README.md index fd28577..eb86e1b 100644 --- a/README.md +++ b/README.md @@ -22,3 +22,37 @@ Import it in your code: ```go import "github.com/gin-contrib/static" ``` + +### Canonical example: + +See the [example](example) + +```go +package main + +import ( + "fmt" + "time" + + "github.com/gin-contrib/cache" + "github.com/gin-contrib/cache/persistence" + "gopkg.in/gin-gonic/gin.v1" +) + +func main() { + r := gin.Default() + + store := persistence.NewInMemoryStore(time.Second) + // Cached Page + r.GET("/ping", func(c *gin.Context) { + c.String(200, "pong "+fmt.Sprint(time.Now().Unix())) + }) + + r.GET("/cache_ping", cache.CachePage(store, time.Minute, 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") +} +```