diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000..74849f7 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,12 @@ +## Machi Documentation Overview + +For a Web-browsable version of a snapshot of the source doc "EDoc" +Erlang documentation, please use this link: +[Machi EDoc snapshot](https://basho.github.io/machi/edoc/). + +## Documents in this directory + +* __chain-self-management-sketch.org__ is an introduction to the +self-management algorithm proposed for Machi. This algorithm is +(hoped to be) sufficient for managing the Chain Replication state of a +Machi cluster.