From 179f6146b2d936d17c92250b10fb532d0bafc927 Mon Sep 17 00:00:00 2001 From: Mike Date: Wed, 13 Mar 2019 03:26:35 -0700 Subject: [PATCH] Added an example for CLI args to the README --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index c951c82..a3a4d4b 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,14 @@ Tells the program to run without making any changes. Instead, it will merely lis Specifies a path to a configuration file or directory. If a directory is specified, all files in the directory will be used as configuration files. +### Example Call With Arguments + +Here's an example of how you might invoke the program with two configuration paths and set globally to a dry run: + +``` +python3 backup-rotator --dry-run --config "/my/config/path-1" --config "/my/config/path-1" +``` + ## Configuration File Format Configuration files are written in [YAML](https://yaml.org/) format. Supported keys are as follows: