diff --git a/redis/README.md b/redis/README.md index aae925bc..b0b4eed9 100644 --- a/redis/README.md +++ b/redis/README.md @@ -33,6 +33,12 @@ func (s *Storage) Keys() ([][]byte, error) ``` ### Installation Redis is tested on the 2 last [Go versions](https://golang.org/dl/) with support for modules. So make sure to initialize one first if you didn't do that yet: + +> **Note:** You can also use [DragonflyDB](https://dragonflydb.io/) as a Redis replacement. +> Since DragonflyDB is fully compatible with the Redis API, you can use it exactly like Redis **without any code changes**. +> [Example](#example-using-dragonflydb) + + ```bash go mod init github.com// ``` @@ -194,3 +200,7 @@ var ConfigDefault = Config{ SentinelPassword: "", } ``` + +### Example: Using DragonflyDB +> **Note:** You can use [DragonflyDB](https://dragonflydb.io/) in the same way as Redis. +> Simply start a DragonflyDB server and configure it just like Redis. Then, call `New()` and use it exactly as you would with Redis. diff --git a/redis/redis.go b/redis/redis.go index f9bdc16a..3969dc4d 100644 --- a/redis/redis.go +++ b/redis/redis.go @@ -13,7 +13,7 @@ type Storage struct { db redis.UniversalClient } -// New creates a new redis storage +// New creates a new Redis storage instance. func New(config ...Config) *Storage { // Set default config cfg := configDefault(config...)