basic functionality

README.md

@@ -0,0 +1,51 @@
+# SPORE
+
+SProcket ORchestration Engine
+
+## Features
+
+- WiFi STA / AP
+- node auto discovery over UDP
+- service registry
+- pub/sub event system
+- Over-The-Air updates
+
+## Supported Hardware
+
+- ESP8266
+
+## Configuration
+
+Choose one of your nodes as the API node to interact with the cluster and configure it in `.env`:
+```sh
+export API_NODE=10.0.1.x
+```
+
+## Build
+
+Build the firmware:
+
+```sh
+./ctl.sh build
+```
+
+## Flash
+
+Flash firmware to a connected device:
+
+```sh
+./ctl.sh flash
+```
+## OTA
+
+Update one nodes:
+
+```sh
+./ctl.sh ota update 10.0.1.x
+```
+
+Update all nodes:
+
+```sh
+./ctl.sh ota all
+```