From d6a014378a82a23e24af14802ff02b835e379306 Mon Sep 17 00:00:00 2001
From: Joel Wetzell <jwetzell@yahoo.com>
Date: Sat, 25 Nov 2023 16:42:45 -0600
Subject: [PATCH] add build and run info to readme

---
 README.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

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 <serial port path>  serialport path
+  -o, --output <output file>       file to write console info to
+  -f, --format <output format>      (choices: "json", "xml", "yaml", default: "json")
+  --websocket <port>               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