From 5cc252342f24049badfb23285ae3cb957d01893d Mon Sep 17 00:00:00 2001 From: Jonathan Strong Date: Thu, 8 Sep 2022 17:37:48 -0400 Subject: [PATCH] update docs --- README.md | 11 +++-------- doc/cli-menu.txt | 4 ++-- 2 files changed, 5 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 49fb397..9442b47 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Use cases: ```console $ ./target/release/registry-backup --help -registry-backup 0.2.0 +registry-backup 0.2.1 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.0] + Value of user-agent HTTP header [default: registry-backup/v0.2.1] --requests-per-second 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. -There are several variables defined in the `justfile` which pertain to rust build settings: - -``` -rustc-version - ## 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 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: diff --git a/doc/cli-menu.txt b/doc/cli-menu.txt index 093599f..a094e8b 100644 --- a/doc/cli-menu.txt +++ b/doc/cli-menu.txt @@ -1,4 +1,4 @@ -registry-backup 0.2.0 +registry-backup 0.2.1 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.0] + Value of user-agent HTTP header [default: registry-backup/v0.2.1] --requests-per-second Requests to registry server will not exceed this rate [default: 25]