enhan: readme file for github
authorMax Voit <max.voit+gtdv@with-eyes.net>
Wed, 19 Aug 2015 13:52:36 +0000 (15:52 +0200)
committerMax Voit <max.voit+gtdv@with-eyes.net>
Wed, 19 Aug 2015 13:52:36 +0000 (15:52 +0200)
examples/readme.md
readme.md [new file with mode: 0644]

index c8adfb4..914c35d 100644 (file)
@@ -1,7 +1,14 @@
 This directory contains some examples demonstrating the use of distributed
 acid-state.
 
+The slave1/2 directories contain symlinks for quick testing on one machine.
+
 # HelloWorld
 
 A simple example analogous to the HelloWorld example in acid-state.
 Run the Master directly here, Slaves in subdirectories.
+
+# Int*Interactive
+
+Contains in Int as state, allows for multiple Updates in a row. The IntState is
+used in the _tests_ as well.
diff --git a/readme.md b/readme.md
new file mode 100644 (file)
index 0000000..b3f9f1d
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,17 @@
+# acid-state-dist
+
+A replication backend for
+[acid-state](http://github.com/acid-state/acid-state "acid-state").
+
+Run an acid-state application on multiple nodes and have all instances operate
+on the same state.
+Two operation modes are provided:
+
+       - Regular operation: without redundancy guarantees but fast,
+       - Redundant operation: guarantees replication on _n_ nodes but slower.
+
+Extented documentation is available via Haddock (/Hackage, as soon as released).
+
+For questions and feedback, feel free to contact me by e-mail
+<max.voit+hdv@with-eyes.net> or via IRC (sdx23 on irc.freenode.net).
+