Skip to content

Commit 3d5df25

Browse files
committed
更新README
1 parent 18b0b99 commit 3d5df25

1 file changed

Lines changed: 13 additions & 1 deletion

File tree

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# raft-java
2-
Raft implementation for Java.<br>
2+
Raft implementation library for Java.<br>
33
参考自[Raft论文](https://github.com/maemual/raft-zh_cn)和Raft作者的开源实现[LogCabin](https://github.com/logcabin/logcabin)
44

55
# 支持的功能
@@ -8,7 +8,19 @@ Raft implementation for Java.<br>
88
* snapshot
99
* 集群成员动态更变
1010

11+
## Quick Start
12+
在本地单机上部署一套3实例的raft集群,执行如下脚本:<br>
13+
cd raft-java-example && sh deploy.sh <br>
14+
该脚本会在raft-java-example/env目录部署三个实例example1、example2、example3;<br>
15+
同时会创建一个client目录,用于测试raft集群读写功能。<br>
16+
部署成功后,测试写操作,通过如下脚本:
17+
cd env/client <br>
18+
./bin/run_client.sh "127.0.0.1:8051,127.0.0.1:8052,127.0.0.1:8053" hello world <br>
19+
测试读操作命令:<br>
20+
./bin/run_client.sh "127.0.0.1:8051,127.0.0.1:8052,127.0.0.1:8053" hello
21+
1122
# 使用方法
23+
下面介绍如何在代码中使用raft-java依赖库来实现一套分布式存储系统。
1224
## 配置依赖
1325
```
1426
<dependency>

0 commit comments

Comments
 (0)