Add CLI config overrides for mi0

1 files changed, 17 insertions, 2 deletions

diff --git a/README.md b/README.md
index 5ef5880..f33e4df 100644
--- a/README.md
+++ b/README.md
@@ -18,8 +18,8 @@ modern `magick` command and falls back to `convert` when needed.
 ## Usage
 
 ```
-    photoalbum --generate [--config PATH]
-    photoalbum --clean [--config PATH]
+    photoalbum --generate [--config PATH] [OPTIONS]
+    photoalbum --clean [--config PATH] [OPTIONS]
     photoalbum --version
     photoalbum --init
 ```
@@ -30,6 +30,21 @@ modern `magick` command and falls back to `convert` when needed.
 * `--version`: Prints out the version
 * `--init`: Creates a `photoalbum.conf` in the current working directory
 
+The following long options can be used with `--generate` or `--clean` to
+override values loaded from `photoalbum.conf`:
+
+* `--incoming PATH`: Overrides `INCOMING_DIR`
+* `--dist PATH`: Overrides `DIST_DIR`
+* `--template PATH`: Overrides `TEMPLATE_DIR`
+* `--title TEXT`: Overrides `TITLE`
+* `--height VALUE`: Overrides `HEIGHT`
+* `--thumbheight VALUE`: Overrides `THUMBHEIGHT`
+* `--maxpreviews N`: Overrides `MAXPREVIEWS`
+* `--shuffle`: Sets `SHUFFLE=yes`
+* `--no-shuffle`: Sets `SHUFFLE=no`
+* `--tarball`: Sets `TARBALL_INCLUDE=yes`
+* `--no-tarball`: Sets `TARBALL_INCLUDE=no`
+
 ## Example usage
 
 1. Run `photoalbum --init`, which creates a `photoalbum.conf` file in the current directory from the installed/default config template.