re-generate docs

README.md

@@ -12,7 +12,7 @@ Use cases:
 ```console
 $ ./target/release/registry-backup --help
 
-registry-backup 0.2.1
+registry-backup 0.2.2
 Jonathan Strong <jstrong@shipyard.rs>
 Download all .crate files from a registry server
 
@@ -32,7 +32,7 @@ OPTIONS:
             Directory where downloaded .crate files will be saved to [default: output]
 
     -u, --user-agent <USER_AGENT>
-            Value of user-agent HTTP header [default: registry-backup/v0.2.1]
+            Value of user-agent HTTP header [default: registry-backup/v0.2.2]
 
         --requests-per-second <REQUESTS_PER_SECOND>
             Requests to registry server will not exceed this rate [default: 25]
@@ -92,18 +92,21 @@ Included commands:
 $ just --list
 
 Available recipes:
-    cargo +args=''         # cargo wrapper; executes a cargo command using the settings in justfile (RUSTFLAGS, etc.)
+    cargo +args=''           # cargo wrapper; executes a cargo command using the settings in justfile (RUSTFLAGS, etc.)
-    check +args=''         # cargo check wrapper
+    check +args=''           # cargo check wrapper
-    debug-build +args=''   # cargo build wrapper - builds registry-backup in debug mode
+    debug-build +args=''     # cargo build wrapper - builds registry-backup in debug mode
-    generate-readme        # generate updated README.md
+    generate-readme          # generate updated README.md
     get-crate-version
-    pre-release            # check, run tests, check non-error output for clippy, run rustfmt
+    pre-release              # check, run tests, check non-error output for clippy, run rustfmt
-    release
+    release                  # release version (regenerate docs, git tag v0.0.0)
-    release-build +args='' # cargo build --release wrapper - builds registry-backup in release mode
+    release-build +args=''   # cargo build --release wrapper - builds registry-backup in release mode
-    release-prep
+    release-prep             # get everything all ready for release
-    test +args=''          # cargo test wrapper
+    show-build-env           # diagnostic command for viewing value of build variables at runtime
-    update-readme          # re-generate README.md and commit changes
+    test +args=''            # cargo test wrapper
-    verify-clean-git       # verify no uncommitted changes
+    update-readme            # re-generate README.md and overwrite existing file with output
+    update-readme-and-commit # re-generate, overwrite, stage, and commit
+    update-readme-and-stage  # re-generate, overwrite, and stage changes
+    verify-clean-git         # verify no uncommitted changes
 
 ```
 
@@ -113,7 +116,7 @@ The commands that mirror cargo commands (e.g. `just test`) are included for the
 
 This file is generated using a template (`doc/README.tera.md`) rendered using updated outputs of the CLI menu, config sample, and other values.
 
-This version of `README.md` was generated at `Thu, 08 Sep 2022 21:43:40 +0000` based on git commit `e7cd43ab`.
+This version of `README.md` was generated at `Fri, 09 Sep 2022 02:45:35 +0000` based on git commit `67814b8a`.
 
 To (re-)generate the `README.md` file, use the justfile command:
 

doc/cli-menu.txt

@@ -1,4 +1,4 @@
-registry-backup 0.2.1
+registry-backup 0.2.2
 Jonathan Strong <jstrong@shipyard.rs>
 Download all .crate files from a registry server
 
@@ -18,7 +18,7 @@ OPTIONS:
             Directory where downloaded .crate files will be saved to [default: output]
 
     -u, --user-agent <USER_AGENT>
-            Value of user-agent HTTP header [default: registry-backup/v0.2.1]
+            Value of user-agent HTTP header [default: registry-backup/v0.2.2]
 
         --requests-per-second <REQUESTS_PER_SECOND>
             Requests to registry server will not exceed this rate [default: 25]

doc/just-commands.txt

@@ -1,13 +1,16 @@
 Available recipes:
-    cargo +args=''         # cargo wrapper; executes a cargo command using the settings in justfile (RUSTFLAGS, etc.)
+    cargo +args=''           # cargo wrapper; executes a cargo command using the settings in justfile (RUSTFLAGS, etc.)
-    check +args=''         # cargo check wrapper
+    check +args=''           # cargo check wrapper
-    debug-build +args=''   # cargo build wrapper - builds registry-backup in debug mode
+    debug-build +args=''     # cargo build wrapper - builds registry-backup in debug mode
-    generate-readme        # generate updated README.md
+    generate-readme          # generate updated README.md
     get-crate-version
-    pre-release            # check, run tests, check non-error output for clippy, run rustfmt
+    pre-release              # check, run tests, check non-error output for clippy, run rustfmt
-    release
+    release                  # release version (regenerate docs, git tag v0.0.0)
-    release-build +args='' # cargo build --release wrapper - builds registry-backup in release mode
+    release-build +args=''   # cargo build --release wrapper - builds registry-backup in release mode
-    release-prep
+    release-prep             # get everything all ready for release
-    test +args=''          # cargo test wrapper
+    show-build-env           # diagnostic command for viewing value of build variables at runtime
-    update-readme          # re-generate README.md and commit changes
+    test +args=''            # cargo test wrapper
-    verify-clean-git       # verify no uncommitted changes
+    update-readme            # re-generate README.md and overwrite existing file with output
+    update-readme-and-commit # re-generate, overwrite, stage, and commit
+    update-readme-and-stage  # re-generate, overwrite, and stage changes
+    verify-clean-git         # verify no uncommitted changes