Skip to content

Commit b5badb7

Browse files
authored
docs: add development manners to readme file (#113)
1 parent 3a65609 commit b5badb7

File tree

2 files changed

+51
-0
lines changed

2 files changed

+51
-0
lines changed

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,11 @@ RedisClient.cluster(nodes: 'rediss://endpoint.example.com:6379', fixed_hostname:
6363
## Interfaces
6464
The following methods are able to be used like `redis-client`.
6565
* `#call`
66+
* `#call_v`
6667
* `#call_once`
68+
* `#call_once_v`
6769
* `#blocking_call`
70+
* `#blocking_call_v`
6871
* `#scan`
6972
* `#sscan`
7073
* `#hscan`
@@ -154,6 +157,51 @@ RedisClient.cluster.new_pool(timeout: 1.0, size: 2)
154157
## Connection drivers
155158
Please see [redis-client](https://github.com/redis-rb/redis-client#drivers).
156159

160+
## Development
161+
Please make sure the following tools are installed on your machine.
162+
163+
| Tool | Version | URL |
164+
| --- | --- | --- |
165+
| Docker | latest stable | https://docs.docker.com/engine/install/ |
166+
| Docker Compose | V2 | https://docs.docker.com/compose/reference/ |
167+
| Ruby | latest stable | https://www.ruby-lang.org/en/ |
168+
| Bundler | latest satble | https://bundler.io/ |
169+
170+
Please fork this repository and check out the codes.
171+
172+
```
173+
$ git clone [email protected]:your-account-name/redis-cluster-client.git
174+
$ cd redis-cluster-client/
175+
$ git remote add upstream https://github.com/redis-rb/redis-cluster-client.git
176+
$ git fetch -p upstream
177+
```
178+
179+
Please install libraries.
180+
181+
```
182+
$ bundle install --path=.bundle --jobs=4
183+
```
184+
185+
Please run Redis cluster with Docker.
186+
187+
```
188+
## If you use Docker server and your OS is Linux:
189+
$ docker compose up
190+
191+
## Else:
192+
$ host_addr="$(ip a | grep eth0 | grep inet | awk '{print $2}' | cut -d'/' -f1)"
193+
$ HOST_ADDR=$host_addr docker compose -f compose.nat.yaml up
194+
$ bundle exec rake "build_cluster[$host_addr]"
195+
```
196+
197+
Please run basic test cases.
198+
199+
```
200+
$ bundle exec rake test
201+
```
202+
203+
You can see more information in the YAML file for GItHub actions.
204+
157205
## See also
158206
* https://github.com/redis/redis-rb/issues/1070
159207
* https://github.com/redis/redis/issues/8948

docs/class_diagrams_redis_cluster_client.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,11 @@ classDiagram
55
class RedisClient_Cluster {
66
+inspect()
77
+call()
8+
+call_v()
89
+call_once()
10+
+call_once_v()
911
+blocking_call()
12+
+blocking_call_v()
1013
+scan()
1114
+sscan()
1215
+hscan()

0 commit comments

Comments
 (0)