raft: add more words about raft protocol

This commit is contained in:
Xiang Li 2015-11-11 09:20:25 -08:00
parent 2d11e7464e
commit 6df52614fc

View File

@ -15,6 +15,11 @@
/*
Package raft provides an implementation of the raft consensus algorithm.
Raft is a protocol by which a cluster of nodes can maintain a replicated state machine.
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
(https://ramcloud.stanford.edu/raft.pdf) by Diego Ongaro and John Ousterhout.
Usage
The primary object in raft is a Node. You either start a Node from scratch