From 585d6900d876607938dcf1d4f5ae21d29cce9b54 Mon Sep 17 00:00:00 2001
From: elliotxx <951376975@qq.com>
Date: Wed, 26 Jul 2023 17:00:11 +0800
Subject: [PATCH] fix: wrong example in README

---
 README.md | 43 +++++++++++++++++++++++--------------------
 1 file changed, 23 insertions(+), 20 deletions(-)

diff --git a/README.md b/README.md
index 4cd0a8d..1e8bb7a 100644
--- a/README.md
+++ b/README.md
@@ -41,17 +41,16 @@ go get github.com/elliotxx/healthcheck
 package main
 
 import (
-    "github.com/gin-gonic/gin"
-    "github.com/elliotxx/healthcheck"
-    "github.com/elliotxx/healthcheck/checks"
+	"github.com/elliotxx/healthcheck"
+	"github.com/gin-gonic/gin"
 )
 
 func main() {
-    r := gin.Default()
+	r := gin.Default()
 
-    healthcheck.Register(r)
-	
-    r.Run()
+	healthcheck.Register(&r.RouterGroup)
+
+	r.Run()
 }
 ```
 
@@ -63,35 +62,39 @@ Or use `NewHandler()` function directly:
 package main
 
 import (
-    "github.com/gin-gonic/gin"
-    "github.com/elliotxx/healthcheck"
-    "github.com/elliotxx/healthcheck/checks"
+	"github.com/elliotxx/healthcheck"
+	"github.com/elliotxx/healthcheck/checks"
+	"github.com/gin-gonic/gin"
 )
 
 func main() {
-    r := gin.Default()
+	r := gin.Default()
+
+	r.GET("livez", healthcheck.NewHandler(healthcheck.NewDefaultHandlerConfig()))
 
-    r.GET("livez", NewHandler(NewDefaultHandlerConfig()))
+	readyzChecks := []checks.Check{checks.NewPingCheck(), checks.NewEnvCheck("DB_HOST")}
+	r.GET("readyz", healthcheck.NewHandler(healthcheck.NewDefaultHandlerConfigFor(readyzChecks...)))
 
-    readyzChecks := []checks.Check{checks.NewPingCheck(), checks.NewEnvCheck("DB_HOST")}
-    r.GET("readyz",NewHandler(NewDefaultHandlerConfigFor(readyzChecks)))
-	
-    r.Run()
+	r.Run()
 }
 ```
 
-Enjoy it!
+Output:
 
 ```shell
-$ curl -k http://localhost/readyz
+$ curl -k http://localhost:8080/readyz
 OK
 
-$ curl -k http://localhost/readyz?verbose
+$ curl -k http://localhost:8080/readyz?verbose
 [+] Ping ok
 [-] Env-DB_HOST ok
 health check failed
 
-$ curl -k http://localhost/readyz?verbose&excludes=Env-DB_HOST
+$ curl -k http://localhost:8080/readyz?verbose&excludes=Env-DB_HOST
 [+] Ping ok
 health check passed
 ```
+
+Enjoy it!
+
+More examples can be seen: [./example_test.go](./example_test.go)