Skip to content

Commit b24e528

Browse files
authored
docs: add background of this gem to readme (#213)
1 parent 5ff11a8 commit b24e528

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ This library is a client for [Redis cluster](https://redis.io/docs/reference/clu
77
It depends on [redis-client](https://github.com/redis-rb/redis-client).
88
So it would be better to read `redis-client` documents first.
99

10+
## Background
11+
This gem is underlying in the official gem which is named as [redis-clustering](https://rubygems.org/gems/redis-clustering).
12+
The redis-clustering gem was decoupled from [the redis gem](https://rubygems.org/gems/redis) since `v5` or later.
13+
Both are maintained by [the repository](https://github.com/redis/redis-rb) in the official organization.
14+
The redis gem supported cluster mode since [the pull request](https://github.com/redis/redis-rb/pull/716) was merged until `v4`.
15+
You can see more details and reasons in [the issue](https://github.com/redis/redis-rb/issues/1070) if you have interest.
16+
1017
## Installation
1118
```ruby
1219
gem 'redis-cluster-client'
@@ -256,5 +263,7 @@ Also, it should handle errors.
256263
* https://github.com/redis/redis-rb/issues/1070
257264
* https://github.com/redis/redis/issues/8948
258265
* https://github.com/antirez/redis-rb-cluster
266+
* https://twitter.com/antirez
267+
* http://antirez.com/latest/0
259268
* https://www.youtube.com/@antirez
260269
* https://www.twitch.tv/thetrueantirez/

0 commit comments

Comments
 (0)