aboutsummaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2014-11-26 17:56:23 +1300
committerTom Ryder <tom@sanctum.geek.nz>2014-11-26 17:56:23 +1300
commit2dd6caaa9b9b40b6f7ce690753d669ff918b1981 (patch)
treeec3f58b9681c227e420affb2e8950344ad535d10 /README.markdown
downloadnscaw-2dd6caaa9b9b40b6f7ce690753d669ff918b1981.tar.gz
nscaw-2dd6caaa9b9b40b6f7ce690753d669ff918b1981.zip
First commit of project
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..17dad48
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,18 @@
+nscaw
+=====
+
+Command wrapper that sends an appropriate passive check to an NSCA server using
+`send_nsca`, depending on the command's outcome.
+
+Make sure `send_nsca` is in `$PATH` and that `NSCAW_SERVER` is set.
+
+ $ nscaw IMPORTANT_JOB -- important-job -o options args ...
+
+License
+-------
+
+Copyright (c) [Tom Ryder][1]. Distributed under [MIT License][2].
+
+[1]: https://sanctum.geek.nz/
+[2]: http://opensource.org/licenses/MIT
+