diff --git a/README.md b/README.md index 8a64c2f..97ca208 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ -# home-monitoring +# Home Monitoring -Privacy-aware MQTT and Home Assistant metrics collector \ No newline at end of file +Privacy-aware collector for the Pfannkuchen monitoring stack. + +- subscribes read-only to MQTT on `10.10.1.1` +- stores numeric and boolean MQTT values in the existing InfluxDB bucket `telegraf` +- polls Home Assistant only through Butler and stores numeric/boolean entity states +- exports no raw string payloads, credentials, location entities, camera/audio/video payloads or discovery documents +- uses the existing `monitoring_network`, InfluxDB and Grafana installation + +Runtime secrets `INFLUX_TOKEN` and `BUTLER_TOKEN` are stored only in Dockhand stack variables.