aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2018-11-20 14:33:26 +1300
committerTom Ryder <tom@sanctum.geek.nz>2018-11-20 14:33:26 +1300
commit531c0c028cbb332b4e1cfb5c479e32e505518fb1 (patch)
tree08f31b77cc22688ff7af49bbfdf6db9812918003 /README.md
parentFix up Makefile (diff)
parentAdd VERSION file (diff)
downloadnscaw-531c0c028cbb332b4e1cfb5c479e32e505518fb1.tar.gz
nscaw-531c0c028cbb332b4e1cfb5c479e32e505518fb1.zip
Merge branch 'release/v1.0.0'v1.0.0
* release/v1.0.0: Add VERSION file Add "all" to .PHONY targets Remove superfluous dest from install target Rename README.markdown to README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ebb1849
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+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`. You'll almost certainly want to set
+`NSCA_SERVER` in `/etc/default/nscaw` as well, but it makes an effort in
+defaulting to `nsca`.
+
+ $ 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