README

[post-pizza-notify.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..f966308
--- /dev/null
+++ b/README
@@ -0,0 +1,21 @@
+Configuration:
+
+ Create a "senderinfo" file containing
+
+  email YOUR EMAIL ADDRESS
+  name YOUR NAME
+
+ Obtain a list of the recipients.  Possible recipients are:
+
+  sms NUMBERWITHOUTSPACES NAME
+  email ADDRESS ADDRESS ADDRESS...    (best to have just one)
+  irctopic SERVER PORT CHANNEL
+  userv SSHUSER@SSHHOST SERVICE-UWER post-pizza
+
+ and they should be in a file "recipients".  "test-recipients"
+ is an example.
+
+To send a notification:
+
+ ./notify senderinfo recipients "Your message goes here"
+