diff --git a/README.md b/README.md index e12662a..602b6be 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,33 @@ -# sk8brd -## Simple remote board control software +# sk8brd - Simple remote board control software -TODO: readme +## Server +`sk8brd-server` is still not there.. The only other implementation is [cdba-server](https://github.com/linux-msm/cdba/) for now. + +## Usage +### Interactive client: +`cargo run -- -f -p -i -b [-u user] [--power-cycle]` + +Keybinds: +* `CTRL-A` + + * `a` -> send a CTRL-A + * `B` -> send a console break + * `p` -> turn off board power + * `P` -> turn on board power + * `q` -> quit + * `s` -> request a JSON status update (WIP) + * `v` -> turn off USB VBUS + * `V` -> turn on USB VBUS + +### Non-interactive CLI: +`cargo run --bin sk8brd-cli -f -i [-b board]` + +Make sure `ssh-agent` is running and has your keys imported. + +## License +`BSD-3-Clause` + +## Credits +``` +Author: Konrad Dybcio +cdba contributors (for the original cdba implementation) +``` \ No newline at end of file