Skip to content

Commit

Permalink
docs: updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lni committed Jun 4, 2022
1 parent 9c07c40 commit e23d27b
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 4 deletions.
11 changes: 10 additions & 1 deletion README.CHS.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
[![Join the chat at https://gitter.im/lni/dragonboat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/lni/dragonboat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

## 项目新闻 ##
* 2022-06-03 Dragonboat v4.0 版本正在开发中,master分支已经是v4的API,具体变化请见[CHANGELOG](CHANGELOG.md)
* 2021-01-20 Dragonboat v3.3 已发布,请查看[CHANGELOG](CHANGELOG.md)获知所有更新情况。

## 关于 ##
Expand Down Expand Up @@ -73,7 +74,15 @@ __Master是用于开发的非稳定branch。生产环境请使用已发布版本

首先请确保Go 1.14或者更新的版本已被安装以获得[Go module](https://github.com/golang/go/wiki/Modules)支持。

请在Go程序中import __github.com/lni/dragonboat/v4__这个包,同时把"github.com/lni/dragonboat/v4 v3.3.0"添加到您的Go应用的go.mod文件的__require__部分。
使用下列命令将Dragonboat v3稳定版加入您的项目:

```
go get github.com/lni/dragonboat/v3@latest
```
或者使用下列命令将开发中的Dragonboat v4版加入您的项目:
```
go get github.com/lni/dragonboat/v4@master
```

[Pebble](https://github.com/cockroachdb/pebble)是默认的用于存储Raft Log的存储引擎。RocksDB与自定义存储引擎的使用方法可参考[这里](docs/storage.CHS.md)

Expand Down
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,22 @@ As visualized below, Stop-the-World pauses caused by Go1.11's GC are sub-millise
* x86_64/Linux, x86_64/MacOS or ARM64/Linux, Go 1.15 or 1.14

## Getting Started ##
__Master is our unstable branch for development. Please use the latest released versions for any production purposes.__ For Dragonboat v3.3.x, please follow the instructions in v3.3.x's [README.md](https://github.com/lni/dragonboat/blob/release-3.3/README.md).
__Master is our unstable branch for development, it is current working towards the v4.0 release. Please use the latest released versions for any production purposes.__ For Dragonboat v3.3.x, please follow the instructions in v3.3.x's [README.md](https://github.com/lni/dragonboat/blob/release-3.3/README.md).

Go 1.14 or above with [Go module](https://github.com/golang/go/wiki/Modules) support is required.
Go 1.17 or above with [Go module](https://github.com/golang/go/wiki/Modules) support is required.

Use the following command to add Dragonboat v3 into your project.

```
go get github.com/lni/dragonboat/v3@latest
```

Or you can use the following command to start using the development version of the Dragonboat, which is current at v4 for its APIs.

```
go get github.com/lni/dragonboat/v4@master
```

To use Dragonboat, make sure to import the package __github.com/lni/dragonboat/v4__. Also add "github.com/lni/dragonboat/v4 v3.3.0" to the __require__ section of your project's go.mod file.

By default, [Pebble](https://github.com/cockroachdb/pebble) is used for storing Raft Logs in Dragonboat. RocksDB and other storage engines are also supported, more info [here](docs/storage.md).

Expand Down

0 comments on commit e23d27b

Please sign in to comment.