Browse Source

re-generate docs

master v0.2.2
Jonathan Strong 2 years ago
parent
commit
1c087e79a3
  1. 15
      README.md
  2. 4
      doc/cli-menu.txt
  3. 9
      doc/just-commands.txt

15
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]
@ -98,11 +98,14 @@ Available recipes:
generate-readme # generate updated README.md
get-crate-version
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-prep
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 commit 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:

4
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]

9
doc/just-commands.txt

@ -5,9 +5,12 @@ Available recipes:
generate-readme # generate updated README.md
get-crate-version
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-prep
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 commit 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

Loading…
Cancel
Save