diff --git a/README.md b/README.md index d8cd23d..cd8aa15 100644 --- a/README.md +++ b/README.md @@ -2,5 +2,13 @@ Summarises borg backups using output from 'borg create'. ## Features -* Parses json output from borg create --json +* Parses json output from 'borg create --json' * Stores Repo and archive information in sqlite database + +### Planned: +* Summary CLI interface +* Output to HTML + +## How to use +Pipe the output of 'borg create --json' to the script, e.g. +> borg create --json /repo/path::name /important/data/ | python3 ./main.py \ No newline at end of file