From 1c087e79a35e794770a7e3dba47f0d7906c2dfbc Mon Sep 17 00:00:00 2001 From: Jonathan Strong Date: Thu, 8 Sep 2022 22:45:35 -0400 Subject: [PATCH] re-generate docs --- README.md | 31 +++++++++++++++++-------------- doc/cli-menu.txt | 4 ++-- doc/just-commands.txt | 25 ++++++++++++++----------- 3 files changed, 33 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index ef515a7..53772e5 100644 --- a/README.md +++ b/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 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 - 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 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.) - check +args='' # cargo check wrapper - debug-build +args='' # cargo build wrapper - builds registry-backup in debug mode - generate-readme # generate updated README.md + cargo +args='' # cargo wrapper; executes a cargo command using the settings in justfile (RUSTFLAGS, etc.) + check +args='' # cargo check wrapper + debug-build +args='' # cargo build wrapper - builds registry-backup in debug mode + generate-readme # generate updated README.md get-crate-version - pre-release # check, run tests, check non-error output for clippy, run rustfmt - release - release-build +args='' # cargo build --release wrapper - builds registry-backup in release mode - release-prep - test +args='' # cargo test wrapper - update-readme # re-generate README.md and commit changes - verify-clean-git # verify no uncommitted changes + pre-release # check, run tests, check non-error output for clippy, run rustfmt + release # release version (regenerate docs, git tag v0.0.0) + release-build +args='' # cargo build --release wrapper - builds registry-backup in release mode + release-prep # get everything all ready for release + show-build-env # diagnostic command for viewing value of build variables at runtime + test +args='' # cargo test wrapper + 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: diff --git a/doc/cli-menu.txt b/doc/cli-menu.txt index a094e8b..d24f37c 100644 --- a/doc/cli-menu.txt +++ b/doc/cli-menu.txt @@ -1,4 +1,4 @@ -registry-backup 0.2.1 +registry-backup 0.2.2 Jonathan Strong 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 - 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 to registry server will not exceed this rate [default: 25] diff --git a/doc/just-commands.txt b/doc/just-commands.txt index 70674a4..971e71d 100644 --- a/doc/just-commands.txt +++ b/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.) - check +args='' # cargo check wrapper - debug-build +args='' # cargo build wrapper - builds registry-backup in debug mode - generate-readme # generate updated README.md + cargo +args='' # cargo wrapper; executes a cargo command using the settings in justfile (RUSTFLAGS, etc.) + check +args='' # cargo check wrapper + debug-build +args='' # cargo build wrapper - builds registry-backup in debug mode + generate-readme # generate updated README.md get-crate-version - pre-release # check, run tests, check non-error output for clippy, run rustfmt - release - release-build +args='' # cargo build --release wrapper - builds registry-backup in release mode - release-prep - test +args='' # cargo test wrapper - update-readme # re-generate README.md and commit changes - verify-clean-git # verify no uncommitted changes + pre-release # check, run tests, check non-error output for clippy, run rustfmt + release # release version (regenerate docs, git tag v0.0.0) + release-build +args='' # cargo build --release wrapper - builds registry-backup in release mode + release-prep # get everything all ready for release + show-build-env # diagnostic command for viewing value of build variables at runtime + test +args='' # cargo test wrapper + 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