aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 24 insertions, 1 deletions
diff --git a/README.md b/README.md
index d1684bc..41cfe79 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,27 @@
simpleton
=========
-A simple tool to check that your services are up \ No newline at end of file
+A simple tool to check that your services are up. About as braindead as it gets, but better than nothing. ;-)
+
+
+Installation
+============
+1. Install prerequisites:
+
+ sudo pip install pyyaml termcolor
+
+2. Create your ~/.simpleton.yaml file:
+
+ HTTP:
+ - http://intra.example.com
+
+ SMTP:
+ - mail.example.com
+
+ FTP:
+ - files.example.com
+
+Todo
+====
+- Add more protocol support, even simple socket connections would be good
+- Deeper checks (SMTP sending, FTP logins, HTML parsing, etc)