Initial README.md commit

README.md

@@ -1,4 +1,21 @@
 osync
 =====
 
-A two way sync script based on rsync that merges obackup script fault tolerance with bitpocket sync logic
+A two way sync script based on rsync that merges obackup script fault tolerance with sync logic based on bitpocket
+
+## About
+
+Having created obackup script in order to make reliable quick backups, i searched for a nice tool to handle two (or more) way sync scenarios in a reliable way.
+While unison handles these scenarios, it's pretty messy to configure, slow and won't handle ACLs.
+That's where bitpocket came handy, a nice script provided by sickill https://github.com/sickill/bitpocket.git
+It's quick and small, but lacks some of the features i searched for like fault tolerance, stop and continue scenarios, and email warnings.
+
+I then decided to merge my obackup codebase with bitpocket's sync core, osync was born.
+
+## Installation
+
+No public release yet (expect it in mid July)
+
+## Author
+
+Orsiris "Ozy" de Jong | ozy@badministrateur.com