From c7d6bdbe9f30e4704ed75719cb2e918943fe2395 Mon Sep 17 00:00:00 2001
From: Silvio Rhatto <rhatto@riseup.net>
Date: Wed, 23 May 2018 12:16:11 -0300
Subject: Updates README and some cleanup

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 43 insertions(+), 2 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 22d1f89..483bc95 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,43 @@
-borger
-======
+# Borger
+
+A script for home folder backups using [Borg](https://borgbackup.readthedocs.io).
+
+# Features
+
+* Multiple destinations using config files.
+* Automatically initializes repository in the remote destination.
+* Automatically pruning of old backups.
+
+# Usage
+
+Create a config for your `servername` destination at `~/.config/borger/servername`:
+
+     # Backup destination
+     export SSH_SERVER="user@host"
+     export SSH_PORT="2202"
+  
+     # Repository path
+     export BORG_REPO_DIR="/var/backups/users/$USER/borg"
+     export BORG_REPO="ssh://$SSH_SERVER:$SSH_PORT/$BORG_REPO_DIR"
+  
+     # Setting one of those, so you won't be asked for your repository passphrase:
+     #export BORG_PASSPHRASE='HACKME'
+     #export BORG_PASSCOMMAND='pass show backup'
+     #export BORG_PASSCOMMAND='keyringer default decrypt borg 2> /dev/null'
+  
+     # Backup config
+     keepdaily="7"
+     keepweekly="4"
+     keepmonth="6"
+     encryption="keyfile"
+     placeholder="{user}"
+
+Then run borger:
+
+    borger servername
+
+# Checking your backups
+
+As simply as
+
+    borger servername --check
-- 
cgit v1.2.3