From 4a3105438cf4ea6f2066261b168c890dfcb8db63 Mon Sep 17 00:00:00 2001
From: George Lacey <git@george.ooo>
Date: Thu, 6 May 2021 02:45:34 +0100
Subject: [PATCH] Add error logging description

---
 README.md | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index b7d4e1e..63ab7be 100644
--- a/README.md
+++ b/README.md
@@ -3,19 +3,23 @@ Summarises [borg](https://borgbackup.readthedocs.io/en/stable/#what-is-borgbacku
 
 ## Features:
 * Parses json output from 'borg create --json'
-* Stores Repo and archive information in sqlite database
-* Print summary of repos
+* Stores repo and archive information in sqlite database
+* Logs errors
+* Prints summary of repos and recent errors
 
 ### Planned:
 * Output to Graphs/HTML
 
 ## How to use
 Pipe the output of 'borg create --json' to the script, for example:
-> borg create --json /repo/path::name /important/data/ | python3 ./main.py -l [label]
+
+> borg create --json /repo/path::name /important/data/ 2>&1 | python3 ./main.py -l [label]
+> 
+> <sup>*(2>&1 redirects errors to borg-manager for logging)</sup>
 
 ### Arguments:
 * -o / --output -> specify database location
-> -o /home/user/borg/logs
+> `-o /home/user/borg/logs`
 * -l / --label -> specify label for borg repo
-> -l "Server backups"
+> `-l 'Server backups'`
 * -s / --summary -> print summary
\ No newline at end of file