From 9756e25f8900f51b215fb45ab7918173f3f97abf Mon Sep 17 00:00:00 2001
From: Pieter Hollander <git@pieterhollander.nl>
Date: Wed, 21 Feb 2024 11:23:11 +0100
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..aee955c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# OpenDTU logger
+
+OpenDTU logger connects to the OpenDTU livedata websocket and captures metrics.
+These metrics are inserted into a PostgreSQL database.
+Optionally, TimescaleDB can be used for better performance.
+
+## Environment variables
+
+```conf
+REMOTE_URL="opendtu:80"
+DB_URL="host=localhost port=5432 user=postgres password=secret dbname=dtu sslmode=disable"
+TIMESCALEDB_ENABLED="true"
+TZ="Europe/Amsterdam"
+```