added something to read

2024-06-09 13:21:34 +02:00
parent cba54b0046
commit a5bc9bb495
3 changed files with 11 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -1,2 +1,4 @@
-# smash
+# smash — SMS Mail Alarm Sending Helper
+
+The configuration is described in [`recipients.cfg` ](recipients.cfg) and [`rules.cfg`](rules.cfg).

--- a/recipients.cfg
+++ b/recipients.cfg
@ -1,2 +1,6 @@
+# list of recipients
+# may contain email adresses and phone numbers for SMS
+# comments via # are allowed
+
 sven.augustin@psi.ch
 0123456789 # not actually a phone number
--- a/rules.cfg
+++ b/rules.cfg
@ -1,3 +1,7 @@
+# list of alarm rules
+# they follow the form: PVNAME COMPARISON VALUE
+# comments via # are allowed
+
 MTEST:COUNTER1 > 0.5 # test
 MTEST:COUNTER2 < 0.5