Browse Source

Add readme

Nathaniel van Diepen 4 years ago
parent
commit
25df3e3fa5
2 changed files with 31 additions and 1 deletions
  1. 1 0
      .gitignore
  2. 30 1
      README.md

+ 1 - 0
.gitignore

@@ -59,3 +59,4 @@ docs/_build/
 target/
 
 var/
+README.html

+ 30 - 1
README.md

@@ -1,2 +1,31 @@
-# backup
+[![PyPi version](https://pypip.in/v/python-backup/badge.png)](https://crate.io/packages/python-backup/)
+[![PyPi downloads](https://pypip.in/d/python-backup/badge.png)](https://crate.io/packages/python-backup/)
+# python-backup
+Configuration file based file backup
 
+## Installation
+`pip install python-backup`
+
+## Usage
+`backup [config-path]`
+
+## Configuration
+python-backup assumes the following folder structure:
+```
+/etc/
+  backup.d/
+    backup.yml
+    sources.d/
+      *.yml
+```
+For examples see the [etc](etc) folder.
+
+## Features
+- rdiff-backup back end
+- Backup dependency chains
+- Multithreaded
+- YAML config files
+
+## Known deficiencies
+- Infinity loops from bad dependency chains
+- No pre/post backup scripts