docs: update

mgtv-tech · Sep 13, 2023 · 4024e1c · 4024e1c
1 parent d8a7721
commit 4024e1c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -71,7 +71,7 @@ func Example_basicUsage() {
 		},
 	})
 
-	mycache := cache.New("basicUsage",
+	mycache := cache.New(cache.WithName("any"),
 		cache.WithRemote(remote.NewGoRedisV8Adaptor(ring)),
 		cache.WithLocal(local.NewFreeCache(256*local.MB, time.Minute)),
 		cache.WithErrNotFound(errRecordNotFound))
@@ -108,7 +108,7 @@ func Example_advancedUsage() {
 		},
 	})
 
-	mycache := cache.New("advancedUsage",
+	mycache := cache.New(cache.WithName("any"),
 		cache.WithRemote(remote.NewGoRedisV8Adaptor(ring)),
 		cache.WithLocal(local.NewFreeCache(256*local.MB, time.Minute)),
 		cache.WithErrNotFound(errRecordNotFound),
@@ -137,6 +137,7 @@ func Example_advancedUsage() {
 ```go
 // Options are used to store cache options.
 type Options struct {
+    name                       string        // Cache name, used for log identification and metric reporting
     remote                     remote.Remote // Remote cache.
     local                      local.Local   // Local cache.
     codec                      string        // Value encoding and decoding method. Default is "msgpack.Name". You can also customize it.

diff --git a/README_zh.md b/README_zh.md
@@ -70,7 +70,7 @@ func Example_basicUsage() {
 		},
 	})
 
-	mycache := cache.New("basicUsage",
+	mycache := cache.New(cache.WithName("any"),
 		cache.WithRemote(remote.NewGoRedisV8Adaptor(ring)),
 		cache.WithLocal(local.NewFreeCache(256*local.MB, time.Minute)),
 		cache.WithErrNotFound(errRecordNotFound))
@@ -107,7 +107,7 @@ func Example_advancedUsage() {
 		},
 	})
 
-	mycache := cache.New("advancedUsage",
+	mycache := cache.New(cache.WithName("any"),
 		cache.WithRemote(remote.NewGoRedisV8Adaptor(ring)),
 		cache.WithLocal(local.NewFreeCache(256*local.MB, time.Minute)),
 		cache.WithErrNotFound(errRecordNotFound),
@@ -136,6 +136,7 @@ func Example_advancedUsage() {
 ```go
 // Options are used to store cache options.
 type Options struct {
+    name                       string        // Cache name, used for log identification and metric reporting
     remote                     remote.Remote // Remote cache.
     local                      local.Local   // Local cache.
     codec                      string        // Value encoding and decoding method. Default is "json.Name" or "msgpack.Name". You can also customize it.