Cleanup

README.md

@@ -3,6 +3,10 @@
 [![Build Status](https://travis-ci.org/go-redis/redis.png?branch=master)](https://travis-ci.org/go-redis/redis)
 [![GoDoc](https://godoc.org/github.com/go-redis/redis?status.svg)](https://pkg.go.dev/github.com/go-redis/redis/v8?tab=doc)
 
+- [Docs](https://redis.uptrace.dev)
+- [Reference](https://pkg.go.dev/github.com/go-redis/redis/v8?tab=doc)
+- [Examples](https://pkg.go.dev/github.com/go-redis/redis/v8?tab=doc#pkg-examples)
+
 ## Sponsors
 
 - [**Uptrace.dev** - distributed traces and metrics](https://uptrace.dev)
@@ -54,35 +58,35 @@ import "github.com/go-redis/redis/v8"
 
 ```go
 func ExampleNewClient() {
-    client := redis.NewClient(&redis.Options{
+    rdb := redis.NewClient(&redis.Options{
         Addr:     "localhost:6379",
         Password: "", // no password set
         DB:       0,  // use default DB
     })
 
-    pong, err := client.Ping(ctx).Result()
+    pong, err := rdb.Ping(ctx).Result()
     fmt.Println(pong, err)
     // Output: PONG <nil>
 }
 
 func ExampleClient() {
-    client := redis.NewClient(&redis.Options{
+    rdb := redis.NewClient(&redis.Options{
         Addr:     "localhost:6379",
         Password: "", // no password set
         DB:       0,  // use default DB
     })
-    err := client.Set(ctx, "key", "value", 0).Err()
+    err := rdb.Set(ctx, "key", "value", 0).Err()
     if err != nil {
         panic(err)
     }
 
-    val, err := client.Get(ctx, "key").Result()
+    val, err := rdb.Get(ctx, "key").Result()
     if err != nil {
         panic(err)
     }
     fmt.Println("key", val)
 
-    val2, err := client.Get(ctx, "key2").Result()
+    val2, err := rdb.Get(ctx, "key2").Result()
     if err == redis.Nil {
         fmt.Println("key2 does not exist")
     } else if err != nil {
@@ -106,13 +110,13 @@ Some corner cases:
 
 ```go
 // SET key value EX 10 NX
-set, err := client.SetNX(ctx, "key", "value", 10*time.Second).Result()
+set, err := rdb.SetNX(ctx, "key", "value", 10*time.Second).Result()
 
 // SORT list LIMIT 0 2 ASC
-vals, err := client.Sort(ctx, "list", &redis.Sort{Offset: 0, Count: 2, Order: "ASC"}).Result()
+vals, err := rdb.Sort(ctx, "list", &redis.Sort{Offset: 0, Count: 2, Order: "ASC"}).Result()
 
 // ZRANGEBYSCORE zset -inf +inf WITHSCORES LIMIT 0 2
-vals, err := client.ZRangeByScoreWithScores(ctx, "zset", &redis.ZRangeBy{
+vals, err := rdb.ZRangeByScoreWithScores(ctx, "zset", &redis.ZRangeBy{
     Min: "-inf",
     Max: "+inf",
     Offset: 0,
@@ -120,16 +124,16 @@ vals, err := client.ZRangeByScoreWithScores(ctx, "zset", &redis.ZRangeBy{
 }).Result()
 
 // ZINTERSTORE out 2 zset1 zset2 WEIGHTS 2 3 AGGREGATE SUM
-vals, err := client.ZInterStore(ctx, "out", &redis.ZStore{
+vals, err := rdb.ZInterStore(ctx, "out", &redis.ZStore{
     Keys: []string{"zset1", "zset2"},
     Weights: []int64{2, 3}
 }).Result()
 
 // EVAL "return {KEYS[1],ARGV[1]}" 1 "key" "hello"
-vals, err := client.Eval(ctx, "return {KEYS[1],ARGV[1]}", []string{"key"}, "hello").Result()
+vals, err := rdb.Eval(ctx, "return {KEYS[1],ARGV[1]}", []string{"key"}, "hello").Result()
 
 // custom command
-res, err := client.Do(ctx, "set", "key", "value").Result()
+res, err := rdb.Do(ctx, "set", "key", "value").Result()
 ```
 
 ## See also