summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorF3RR3T <github@st33v.com>2014-08-24 15:01:35 +1000
committerF3RR3T <github@st33v.com>2014-08-24 15:01:35 +1000
commite90ead311dff1bccd50cbea8e2e915c185537e53 (patch)
treeaa228778835e1335ecdff1d9c611bb84ffff1512
parent064edd67e0535f01a98282505e34ce02eb03befa (diff)
First (minor) cut of readme file
-rw-r--r--README.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/README.md b/README.md
index ec646d1..2b94241 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,10 @@
-monitor
+monitor.sh
=======
-Automated email sender that monitors and reports on network and sensors.
+*Automated email sender that monitors and reports on network and sensors*
+
+This script is called periodically (such as from a cron job). It obtains the internet (external IP
+address and logs it to a temporary file. When the external IP address changes, the following steps occur:
+- The owner is notified by email of the address change.
+- The log file is deleted.
+