diff --git a/README.md b/README.md index 6fed6eb..d5adee6 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,24 @@ This will launch Harmony's minimalist terminal ui which embeds a few demo scores Usage instructions will be displayed at the bottom of the TUI. +`cargo run --bin example-cli -- --help` + +This is the harmony CLI, a minimal implementation + +The current help text: + +``` +Usage: example-cli [OPTIONS] --run + +Options: + -r, --run Name of score to run + -i, --interactive Run interactive or not + -a, --all Run all or nth + -n, --number Run nth matching, zero indexed [default: 0] + -h, --help Print help + -V, --version Print version +``` + ## Core architecture ![Harmony Core Architecture](docs/diagrams/Harmony_Core_Architecture.drawio.svg)