diff --git a/README.md b/README.md new file mode 100644 index 0000000..d1b9f17 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# improv-setup + +Configure Wifi credentials on IOT devices using [Improv](https://www.improv-wifi.com/) serial protocol. + +``` +Usage: improv-setup device [OPTIONS] [COMMAND] + +Commands: + state Request current state + set-wifi Set wifi credentials + info Request device info + help Print this message or the help of the given subcommand(s) + +Arguments: + Path to the serial device + +Options: + --baud-rate Baud rate used for connecting to the serial device [default: 115200] + -h, --help Print help +```