瀏覽代碼

raft: add raftexample to the docs

To help people wanting use this package get started point to the
raftexample package.
Brandon Philips 10 年之前
父節點
當前提交
c72e4ae112
共有 1 個文件被更改,包括 3 次插入0 次删除
  1. 3 0
      raft/doc.go

+ 3 - 0
raft/doc.go

@@ -20,6 +20,9 @@ The state machine is kept in sync through the use of a replicated log.
 For more details on Raft, you can read In Search of an Understandable Consensus Algorithm
 For more details on Raft, you can read In Search of an Understandable Consensus Algorithm
 (https://ramcloud.stanford.edu/raft.pdf) by Diego Ongaro and John Ousterhout.
 (https://ramcloud.stanford.edu/raft.pdf) by Diego Ongaro and John Ousterhout.
 
 
+A simple example application called, raftexample, is also avialable to help illustrate how to use this package in practice:
+https://github.com/coreos/etcd/tree/master/contrib/raftexample
+
 Usage
 Usage
 
 
 The primary object in raft is a Node. You either start a Node from scratch
 The primary object in raft is a Node. You either start a Node from scratch