diff --git a/README.md b/README.md index a2b326f..1555b5c 100644 --- a/README.md +++ b/README.md @@ -10,4 +10,25 @@ - soccer - hockey - track -- whirley \ No newline at end of file +- whirley + +## Build +- clone/download repo +- in repo run `npm install && npm run build:cli` +- find binary in `packages/cli/dist/` + +## Usage +``` +Usage: aas-cli [options] + +Simple protocol router /s + +Options: + -V, --version output the version number + -d, --device serialport path + -o, --output file to write console info to + -f, --format (choices: "json", "xml", "yaml", default: "json") + --websocket enable websocket server for updates + -h, --help display help for command +``` +If a device isn't supplied with the `-d/--device` flag then you will be prompted to select one. \ No newline at end of file