diff --git a/README.md b/README.md index 547678f..1a5e2e1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,19 @@ # wabocli -CLI for interacting with the Wandelbots platform + +The swiss army knife for interacting with [Wandelbots NOVA](https://www.wandelbots.com/). + +## Install + +### MacOS/Linux + +Installation with [homebrew](https://brew.sh/): +```bash +brew install wandelbotsgmbh/wandelbots/nova + +# enable autocompletion for zsh (has to be done only once) +echo 'source <(nova completion zsh)' >> ~/.zshrc +``` + +### Download Binaries + +Find the latest versions under https://github.com/wandelbotsgmbh/wabocli/releases