From 09bf5fbd2a3aee2ab15eec9104ee07c4b128583a Mon Sep 17 00:00:00 2001
From: Jonathan Strong <jonathan@keyrock.eu>
Date: Thu, 8 Sep 2022 23:02:41 -0400
Subject: [PATCH] adds install, build from source, running tests sections

---
 README.md          | 24 +++++++++++++++++++++++-
 doc/README.tera.md | 22 ++++++++++++++++++++++
 2 files changed, 45 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index b0f178a..8e1a8f2 100644
--- a/README.md
+++ b/README.md
@@ -28,6 +28,12 @@ $ registry-backup \
     --requests-per-second 10
 ```
 
+## Install
+
+```console
+$ cargo install registry-backup --git https://git.shipyard.rs/jstrong/registry-backup.git
+```
+
 ## Runtime Options
 
 ```console
@@ -103,6 +109,22 @@ format = "/{crate}/{version}/download"
 
 ```
 
+## Build From Source
+
+```console
+$ git clone https://git.shipyard.rs/jstrong/registry-backup.git
+$ cd registry-backup
+$ just release-build # alternatively, cargo build --bin registry-backup --release
+# ./target/release/registry-backup --help
+# cp target/release/registry-backup ~/.cargo/bin/
+```
+
+## Running Tests
+
+```console
+$ just test # alternatively, cargo test
+```
+
 ## Justfile
 
 The repository includes a `justfile` with functionality for building, testing, etc.
@@ -137,7 +159,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 `Fri, 09 Sep 2022 02:55:22 +0000` based on git commit `1c087e79`.
+This version of `README.md` was generated at `Fri, 09 Sep 2022 03:02:19 +0000` based on git commit `fd6191e9`.
 
 To (re-)generate the `README.md` file, use the justfile command:
 
diff --git a/doc/README.tera.md b/doc/README.tera.md
index fc58595..873b548 100644
--- a/doc/README.tera.md
+++ b/doc/README.tera.md
@@ -28,6 +28,12 @@ $ registry-backup \
     --requests-per-second 10
 ```
 
+## Install
+
+```console
+$ cargo install registry-backup --git https://git.shipyard.rs/jstrong/registry-backup.git
+```
+
 ## Runtime Options
 
 ```console
@@ -44,6 +50,22 @@ A toml configuration file may be used instead of command line flags. A sample fi
 {{ config_sample }}
 ```
 
+## Build From Source
+
+```console
+$ git clone https://git.shipyard.rs/jstrong/registry-backup.git
+$ cd registry-backup
+$ just release-build # alternatively, cargo build --bin registry-backup --release
+# ./target/release/registry-backup --help
+# cp target/release/registry-backup ~/.cargo/bin/
+```
+
+## Running Tests
+
+```console
+$ just test # alternatively, cargo test
+```
+
 ## Justfile
 
 The repository includes a `justfile` with functionality for building, testing, etc.