aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMax Resnick <max@ofmax.li>2018-11-03 16:30:48 -0700
committerMax Resnick <max@ofmax.li>2018-11-03 16:32:25 -0700
commit75a06c534e0f5bf872d6818f9de4bfb39e64bc9a (patch)
tree28bdddfeae88939399375d1e10b5f2c3226992d4 /README.md
parent002e965f6d1201fc1a33d76978de27c7db6b1b6f (diff)
downloadrestic-wrapper-75a06c534e0f5bf872d6818f9de4bfb39e64bc9a.tar.gz
Initial Commit
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