From 0d91689b4745527698e62a0512f19fa6af555c5a Mon Sep 17 00:00:00 2001 From: Manuel Hatzl Date: Thu, 21 Sep 2023 08:51:16 +0200 Subject: [PATCH] fix: add setup section in README --- Cargo.lock | 2 +- Cargo.toml | 2 +- README.md | 20 ++++++++++++++++++++ 3 files changed, 22 insertions(+), 2 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 4f0361e..a64cb16 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -307,7 +307,7 @@ dependencies = [ [[package]] name = "mantra" -version = "0.2.13" +version = "0.2.14" dependencies = [ "clap", "ignore", diff --git a/Cargo.toml b/Cargo.toml index 61a5cee..f678f38 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "mantra" -version = "0.2.13" +version = "0.2.14" edition = "2021" authors = ["Manuel Hatzl"] description = "Tool to trace requirements down to implementation and tests." diff --git a/README.md b/README.md index ba05e9c..7c546ce 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,26 @@ The repository name is then added to the entry in the *references* list. ``` ## Usage +### Setup + +*mantra* is available on [crates.io](https://crates.io/crates/mantra), and may be installed using the Rust [toolchain](https://www.rust-lang.org/tools/install): + +`cargo install mantra` + +Alternatively, *mantra* is available as Docker [image](https://hub.docker.com/r/manuelhatzl/mantra), and may be run locally with: + +`docker run manuelhatzl/mantra:main mantra` + +To use the Docker image inside GitHub workflows, use: + +```yaml +runs-on: ubuntu-latest +container: + image: manuelhatzl/mantra:main +``` + +**Note:** The image is based on the Alpine [image](https://hub.docker.com/_/alpine), and may not support all commands available with the Ubuntu image. + ### Commands *mantra* is primarily a command line tool that offers various commands.\