aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/README.md b/README.md
index f988468..bd06938 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,13 @@
-RESTIC WRAPPER
+# restic-py
+
+a stupid wrapper using `sh` module to run and monitor backups
+
+## Features
+
+### Large/Primary Directory seperation
+
+Seperates operations for key directories that are likely to have large numbers of files/disk spaces, this allows for better error handling, monitor and snapshot prunes.
+
+### Monitoring
+
+A continious monitoring service that allows real time monitoring of backups for errors