Updated the README.

README.md

@@ -1,3 +1,47 @@
 # avionmqtt
 
 A python library to control bridge between Avi-on based lights and Home Assistant using MQTT
+
+## support
+This should support any devices that uses Avi-on's technology, including Halo Home and GE branded BLE lights (both discontinued, but both supported by Avi-on's cloud infra and mobile apps).
+
+# features
+- creates lights for devices and groups in Home Assistant
+- supports changing brightness and color temperature
+- polls the whole network on startup to get the current state of each device
+- updates Home Assistant whenever devices are updated externally 
+
+# how to use
+
+```bash
+pip install avionmqtt
+python -m avionmqtt -s settings.yaml
+```
+
+> [!WARNING]
+> This script currently does not have any graceful handling of SIGINT and so will leave the BLE connection dangling.
+> Use the `sudo bluetoothctl power off && sudo bluetoothctl power on` or similar to reset the adapter.
+
+# settings.yaml
+
+```yaml
+avion:
+    email: [email protected]
+    password: ********
+
+mqtt:
+    host: mqtt_broker.local
+    username: avion
+    password: avion
+
+devices:
+    import: true
+
+groups:
+    import: true
+
+```
+
+
+# acknowledgements
+This project would not have been possible without the original work done in https://github.com/nkaminski/csrmesh and https://github.com/nayaverdier/halohome