diff --git a/README.md b/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..262836326b47e6eb030c6375f2d4b617dcddbdc2
--- /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