From e8d46f76ec3a02512683e9916049abb33fb303ec Mon Sep 17 00:00:00 2001
From: Elmar Ludwig <elmar.ludwig@uni-osnabrueck.de>
Date: Mon, 28 Oct 2024 12:06:45 +0100
Subject: [PATCH] add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2628363
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+This module implements an OpenMetrics compatible data exporter as a Stud.IP
+plugin, its endpoint can directly be plugged into Prometheus as a data source.
+
+The exporter uses HTTP basic authentication by default, the credentials must
+be configured in Stud.IP via the global setting `PROMETHEUS_AUTH`.
+
+Metrics export URL: `<studip-url>/plugins.php/prometheusmetrics`
+
+References:
+- https://prometheus.io/docs/instrumenting/exporters/
+- https://github.com/prometheus/OpenMetrics/blob/main/specification/OpenMetrics.md
-- 
GitLab