From 9ad87e3baa2b19303e05abaf2ae93ea0651e2d97 Mon Sep 17 00:00:00 2001
From: Elena ``of Valhalla'' Grandi <valhalla@trueelena.org>
Date: Fri, 14 Mar 2025 08:38:43 +0100
Subject: Document the settings.toml

---
 README.rst | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README.rst b/README.rst
index 2e39e3e..54d029b 100644
--- a/README.rst
+++ b/README.rst
@@ -7,3 +7,22 @@ Hardware
 
 * Raspberry Pico2W
 * 12 RGB LED ring
+
+Dependencies
+============
+
+settings.toml
+-------------
+
+the clock requires a ``settings.toml`` with the following variables:
+
+``CIRCUITPY_WIFI_SSID``
+   your wifi ssd
+``CIRCUITPY_WIFI_PASSWORD``
+   your wifi password
+``MQTT_HOST``
+   the mqtt server you want to use
+``MQTT_SENS_FEED``
+   a base topic that receives messages from sensors, with a topic in the
+   form ``MQTT_SENS_FEED/<location>/<type>`` and a numeric value as the
+   payload.
-- 
cgit v1.2.3