From cdf46c7bcfdb4297ca00e66fdccf243889a7d561 Mon Sep 17 00:00:00 2001
From: Jan David Mol <mol@astron.nl>
Date: Wed, 31 Jan 2024 10:08:57 +0100
Subject: [PATCH] added documentation

---
 README.md | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index c613d21..ea71b17 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,8 @@ docker-compose build
 docker-compose up
 ```
 
+## Look around
+
 Once the stack has booted up, you can visit:
 
 * http://localhost:8000/polls to get to the entry point for the API of the demo app.
@@ -34,6 +36,11 @@ django_model_inserts_total{model="question"} 0.0
 django_model_inserts_total{model="choice"} 0.0
 ```
 
-Furthermore, the default dashboard relies on ```prometheus/django.rules``` to evaluate those formulas faster
-when asked.
+## Notes
+
+The plugin's documentation describes well how Django is to be extended to provide the above
+metrics, and this repo allows you to play with such a setup.
+
+The setup also includes a configuration for Prometheus. The provided dashboard in Grafana relies on 
+```prometheus/django.rules``` to be active, to evaluate its formulas faster when asked.
 
-- 
GitLab