From 01733c0bc7388a0fe0cda2ec107691fde2f0d322 Mon Sep 17 00:00:00 2001
From: Marius <marius@twostairs.com>
Date: Thu, 18 Apr 2019 23:47:17 +0200
Subject: [PATCH] README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3e9fcd4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+hue2influx
+----------
+
+Sync Philips Hue component states to InfluxDB.
+
+## Environment variables
+
+```sh
+HUE_BRIDGE="your bridge IP or hostname here"
+INFLUXDB_SERVER="your InfluxDB server IP or hostname here"
+INFLUXDB_PORT=your InfluxDB port (tcp or udp) here
+INFLUXDB_UDP="0" for TCP, "1" for UDP
+INFLUXDB_DB="your InfluxDB database here"
+INFLUXDB_USER="your InfluxDB username here"
+INFLUXDB_PASS="your InfluxDB password here"
+```
+
+## Running locally
+
+```sh
+$ pip3 install influxdb phue
+$ python3 ./hue2influx.py
+```
+
+## Docker
+
+```sh
+docker run -it --rm -e HUE_BRIDGE="your bridge IP or hostname here" -e INFLUXDB_SERVER="your InfluxDB server IP or hostname here" -e ... mrusme/hue2influx:latest
+```
-- 
GitLab