From 115d43cc792cecca700d6a5affabb56614b65c81 Mon Sep 17 00:00:00 2001
From: Mario Voigt <mario.voigt@stadtfabrikanten.org>
Date: Mon, 3 Mar 2025 22:41:59 +0000
Subject: [PATCH] Give some more info in readme

---
 README.md | 28 ++++++++++++++++++++--------
 1 file changed, 20 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index dd256be..e60c6d4 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,23 @@
 # Prometheus Exporter
 
-Export BFFH Data as Prometheus Metric
+Export BFFH Data as Prometheus Metric.
 
-# Env Variables
-* POLLING_INTERVAL_SECONDS = 5
-* EXPORTER_PORT = 9000
-* BFFH_HOST = localhost
-* BFFH_PORT = 59661
-* BFFH_USER = Admin1
-* BFFH_PASSWORD = secret
\ No newline at end of file
+The exporter uses the [pyfabapi](https://docs.fab-access.org/books/schnittstellen-und-apis/page/fabaccess-api#bkmrk-pyfabapi) (Python API wrapper for FabAccess API) to access the resource list (machines) and their states and meta information (names, categories).
+
+Sample line:
+```
+bffh_machine_state{category="Central Stairs",machine_id="zam-raum1-ecke1-lamp",machine_name="1 Lampe"} 1.0
+```
+
+# Installation & Documentation
+Please see [docs.fab-access.org](https://docs.fab-access.org/books/schnittstellen-und-apis/page/monitoring-prometheus-loki-und-grafana#bkmrk-installation-von-fab) for installation steps and how to use together with Grafana.
+
+## Installation with Docker
+In case you want to use the provided Dockerfile, you can use the following environment variables to run:
+
+* `POLLING_INTERVAL_SECONDS` = 5
+* `EXPORTER_PORT` = 9000
+* `BFFH_HOST` = localhost
+* `BFFH_PORT` = 59661
+* `BFFH_USER` = Admin1
+* `BFFH_PASSWORD` = secret
\ No newline at end of file