# HG changeset patch
# User Laman
# Date 2019-05-29 12:23:48
# Node ID 3274b492daa173e020854d606470b0e4dd5a2687
# Parent  1cb7362ae1326311b9b281b36753864e5a978761

added readme

diff --git a/readme.md b/readme.md
new file mode 100644
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,9 @@
+# Morevna #
+
+A backup and synchronization script. Uses rdiff-backup to back up data to a LUKS container and synchronizes its updates across devices.
+
+`morevna.sh` runs the top level operations (consider it my example configuration), `morevna.py` is responsible for the synchronization.
+
+Because the objective is to store an opaque container without necessarily trusting the device, it is troublesome to effectively propagate the changes. But we know that the data are internally aligned to blocks. Therefore we hash the entire file block by block, build a hash tree over the leaves and compare the client and server trees to determine which blocks to transmit.
+
+In my use (8GB container stored on a magnetic hard drive) the main performance bottleneck is reading the entire file.