From 6bfbe4e58b92dd95f62b9c170073d6b38213d2d6 Mon Sep 17 00:00:00 2001 From: Julien Lamarche Date: Fri, 10 Nov 2017 13:54:24 -0500 Subject: [PATCH] improved documentation in READEME --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 41edfe6..0fb45d8 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,9 @@ The initial design does not aim to be a 24/7 paging sytem. Rather * But don't email too often afterwards (once a day to once an hour) If a script in the directory returns non-zero, the output sent by the script (in standard output) will be printed and sent by email. + +Thus, the required design for adding monitoring features is simple: +* If no error or warning, return 0 +* If there is an error or warning, return non zero and print message to standard output + +The name dumuzid comes from the Sumerian diety of the same name, "Dumuzid the Shepherd".