Browse Source

update docs

master v0.2.1
Jonathan Strong 2 years ago
parent
commit
5cc252342f
  1. 11
      README.md
  2. 4
      doc/cli-menu.txt

11
README.md

@ -12,7 +12,7 @@ Use cases:
```console ```console
$ ./target/release/registry-backup --help $ ./target/release/registry-backup --help
registry-backup 0.2.0 registry-backup 0.2.1
Jonathan Strong <jstrong@shipyard.rs> Jonathan Strong <jstrong@shipyard.rs>
Download all .crate files from a registry server Download all .crate files from a registry server
@ -32,7 +32,7 @@ OPTIONS:
Directory where downloaded .crate files will be saved to [default: output] Directory where downloaded .crate files will be saved to [default: output]
-u, --user-agent <USER_AGENT> -u, --user-agent <USER_AGENT>
Value of user-agent HTTP header [default: registry-backup/v0.2.0] Value of user-agent HTTP header [default: registry-backup/v0.2.1]
--requests-per-second <REQUESTS_PER_SECOND> --requests-per-second <REQUESTS_PER_SECOND>
Requests to registry server will not exceed this rate [default: 25] Requests to registry server will not exceed this rate [default: 25]
@ -108,16 +108,11 @@ Available recipes:
The commands that mirror cargo commands (e.g. `just test`) are included for the purpose of convenience, so that various options (e.g. `RUSTFLAGS='-C target-cpu=native`) can be included without typing them out each time. The commands that mirror cargo commands (e.g. `just test`) are included for the purpose of convenience, so that various options (e.g. `RUSTFLAGS='-C target-cpu=native`) can be included without typing them out each time.
There are several variables defined in the `justfile` which pertain to rust build settings:
```
rustc-version
## Generating README.md ## Generating README.md
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 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:34:29 +0000` based on git commit `3a8426f1`. This version of README.md was generated at `Thu, 08 Sep 2022 21:37:48 +0000` based on git commit `ea7545dc`.
To (re-)generate the README.md file, use the justfile command: To (re-)generate the README.md file, use the justfile command:

4
doc/cli-menu.txt

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

Loading…
Cancel
Save