Added READMEHEADmaster

1 files changed, 24 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8213faf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# `EZWIFI`
+
+`EZWIFI` is an ESP32 component for setting up Wi-Fi and collecting channel state information (CSI) from received frames.
+
+## Usage
+
+A node is configured as either an access point (AP) or a station (STA):
+
+	// Configure this node as an access point
+	setup_softap();
+
+	// ...or as a station
+	setup_station();
+
+	// Enable CSI collection, filtering on the sender's MAC address
+	setup_csi("AA:BB:CC:DD:EE:FF");
+
+Once running, `is_wifi_connected()` reports connection status, and `get_csi()` returns a pointer to the most recently received CSI frame.
+
+	if (is_wifi_connected()) {
+	    wifi_csi_info_t *csi = get_csi();
+	}
+
+This was originally built for a two-node presence/activity-detection system, where one node ran as AP and the other as STA.