Browse Source

Merge pull request #4045 from philips/add-raftexample-to-raft-docs

raft: add raftexample to the docs
Xiang Li 10 years ago
parent
commit
79fa03081c
1 changed files with 3 additions and 0 deletions
  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