From 4596cc602d2115a5d36829aa03850e9d0c50dcc5 Mon Sep 17 00:00:00 2001
From: David Runge <dave@sleepmap.de>
Date: Thu, 26 Mar 2015 02:00:44 +0100
Subject: README.md: Updating with requirements, configuration, TODO and
 license.

---
 README.md | 46 +++++++++++++++++++++++++++++++++-------------
 1 file changed, 33 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 3b8609b..51f2a41 100644
--- a/README.md
+++ b/README.md
@@ -5,17 +5,37 @@ This collection of systemd timers/services and scripts enables a precise - gpg e
 System-wide backups and user-specific backups are possible.
 
 ## Features
-**System**: Backups of the following program settings/ folders are possible:  
-- aura
-- bitlbee
-- git
-- mail/ mailman
-- mariadb
-- /var/log
-- /var/log/journal
-- websites
-
-**User**: Backups of the following program profiles are possible:
-- firefox
-- thunderbird
+Backups of the following program settings/profiles/folders are possible:  
+### System
+* aura
+* bitlbee
+* git
+* mail/ mailman
+* mariadb
+* /var/log
+* /var/log/journal
+* websites
 
+### User
+* firefox
+* thunderbird
+
+## Requirements
+At the moment crypted-backups only supports [xz](http://tukaani.org/xz/) compression.  
+
+## Configuration
+Crypted-backups uses two forms of configuration files. One for system-wide services and one for user services.  
+
+### System
+The configuration file for system services can be found in */etc/crypted-backups* and is well documented.
+
+### User
+The configuration file for user services is read from *$HOME/.config/crypted-backups*. 
+Make sure to copy and modify one from your system skeleton folder (**/etc/skel/.crypted-backups**).
+
+## TODO
+* Using [pixz](https://github.com/vasi/pixz)
+* Using [rsync](https://rsync.samba.org/) for backup mirroring
+
+## License
+Crypted-backups is licensed under the GPLv3.
-- 
cgit v1.2.3-70-g09d2