Added readme to led controller

srgtuszy · Oct 28, 2024 · 4221c40 · 4221c40
1 parent 64ead47
commit 4221c40
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/led-controller/README.mdown b/led-controller/README.mdown
@@ -0,0 +1,5 @@
+# LED controller
+
+This part runs on raspberry pi (ideally) attached to or in the vicinity of the LED strip. Whenever a user completes a challenge and makes this planet a more sustainable place, this program will light up to celebrate.
+
+The program requires a firebase service account to be set via environment variable under `FIREBASE_SERVICE_ACCOUNT_PATH` key. It's expected that an active internet connection is present in order to react to changes from firestore.