Sane rsync returncodes

[butterbackup.git] / README.md

diff --git a/README.md b/README.md
index ce840f16489bdd51df2230d878ca15a73f80ec2c..63397f71e1a4d73d4dffb452099b83fa3432fea0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,17 @@
 butterbackup
 ============
 
-Butterbackup is a backup system which stores snapshots in btrfs on a central server. A web gui allows for simple restore of files. 
\ No newline at end of file
+Butterbackup is a backup system which stores snapshots in btrfs on a central server. A web gui allows for simple restore of files. 
+
+For now it is rather crude. To get started backing up some manual work is needed.
+<pre lang="bash"><code>
+Create /etc/butterbackup
+# echo "--exclude /tmp --exclude /proc --exclude /sys --exclude /dev" > /etc/butterbackup/default.cfg
+# touch /etc/butterbackup/machine1.example.com
+# touch /etc/butterbackup/machine2.example.com
+# ssh-copy-id root@machine1.example.com
+# ssh-copy-id root@machine1.example.com
+# mkdir /mnt/data2
+# mkfs.btrfs /dev/sdb1
+# mount /dev/sdb1 /mnt/data2  #hardcoded for now
+</code></pre>