From dcc357c6faee84c1664613a606e664884799f5e2 Mon Sep 17 00:00:00 2001 From: Andreas Wagner Date: Thu, 12 Nov 2020 15:40:15 +0200 Subject: [PATCH] add example for backup syntax (#24) Co-authored-by: whysthatso --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 590b7fb..03d3d26 100644 --- a/README.md +++ b/README.md @@ -140,6 +140,16 @@ Available variables: | `schedule_month` | no (`*`) | Month when the job is run. ( 1-12, *, */2, etc ) | | `exclude` | no (`{}`) | Allows you to specify files to exclude. See [Exclude](#exclude) for reference. | +Example: +```yaml +restic_backups: + - name: data + repo: remove + src: /path/to/data + scheduled: true + schedule_hour: 3 +``` + #### Exclude the `exclude` key on a backup allows you to specify multiple files to exclude or files to look for filenames to be excluded. You can specify the following keys: