Merge branch 'master' into feat/settingUpNDC

README.md

@@ -1,13 +1,36 @@
-### Watch the whole repo on every change
+# Harmony : Open Infrastructure Orchestration
 
-Due to the current setup being a mix of separate repositories with gitignore and rust workspace, a few options are required for cargo-watch to have the desired behavior :
+## Quick demo
 
-```sh
-RUST_LOG=info cargo watch --ignore-nothing -w harmony -w private_repos/ -x 'run --bin nationtech' 
-```
+`cargo run -p example-tui`
 
-This will run the nationtech bin (likely `private_repos/nationtech/src/main.rs`) on any change in the harmony or private_repos folders.
+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]
+
+Options:
+  -y, --yes              Run score(s) or not
+  -f, --filter <FILTER>  Filter query
+  -i, --interactive      Run interactive TUI or not
+  -a, --all              Run all or nth, defaults to all
+  -n, --number <NUMBER>  Run nth matching, zero indexed [default: 0]
+  -l, --list             list scores, will also be affected by run filter
+  -h, --help             Print help
+  -V, --version          Print version```
+
+## Core architecture
+
+![Harmony Core Architecture](docs/diagrams/Harmony_Core_Architecture.drawio.svg)
+````
 ## Supporting a new field in OPNSense `config.xml`
 
 Two steps: