From b2ea6c955b1a7bbb6914add3a3c51d3ba6f4c328 Mon Sep 17 00:00:00 2001
From: clerie <git@clerie.de>
Date: Sat, 21 Dec 2024 14:34:42 +0100
Subject: [PATCH] Add README

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 README.md

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] <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
+```