Add README

This commit is contained in:
clerie 2024-12-21 14:34:42 +01:00
parent ff7338df6d
commit b2ea6c955b

20
README.md Normal file
View File

@ -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] <PATH> [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> Path to the serial device
Options:
--baud-rate <BAUD_RATE> Baud rate used for connecting to the serial device [default: 115200]
-h, --help Print help
```