update documentation

README.md

@@ -1,5 +1,9 @@
 # RingPi-Bot
 
-Based on RaspBerryPi Zero and switching a GPIO 
-via optocoupler through 12VAC from the doorbell.
-see [wiring.png](hardware/wiring.png)
+When the doorbell rings, a message is sent to a private Telegram chat group.
+
+Based on RaspBerryPi Zero and switching a GPIO via optocoupler through 12VAC
+from the doorbell, see [wiring.png](hardware/wiring.png)
+
+
+

bot/ring_bot.py

@@ -15,11 +15,11 @@
 from telepot.loop import MessageLoop
 
 from bot import singleton
-from config import RING_BOT_TOKEN, RING_RING_GROUP, THK, \
-    switch_state, \
-    DING_DONG, WELCOME, RUNNING, STOPPED, UNKNOWN_CMD, UNKNOWN_TYPE, \
-    RING_BOT_NAME, CMD_START, CMD_STOP, CMD_REBOOT, REBOOT, START, STARTED, \
-    STOPPING
+from config import RING_BOT_TOKEN, RING_BOT_NAME, RING_RING_GROUP, \
+    THK  # no public deployment (secret.py)
+from config import switch_state, DING_DONG, WELCOME, RUNNING, STOPPED, \
+    UNKNOWN_CMD, UNKNOWN_TYPE, CMD_START, CMD_STOP, CMD_REBOOT, REBOOT, \
+    START, STARTED, STOPPING
 from logger import LOGGER
 
 

config/__init__.py

@@ -8,4 +8,4 @@
 # -----------------------------------------------------------
 from .constants import *
 from .gpio import *
-from .secret import *
+from .secret import *  # no public deployment