summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authortv <tv@also>2011-01-15 18:27:25 +0100
committertv <tv@also>2011-01-15 18:27:25 +0100
commit1eb3e2017502ddb94cc57e7edc2812893b686163 (patch)
tree7fde66e99b0a72ea0f0325246ee199a8134c6687
initial commit
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..0ef38df3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# Genericore irclog
+
+This package contains a Genericore output module to forward logs to IRC.
+
+*Please note that this is early development software
+ that lacks proper documentation, tests, and a lot of useful or even necessary features.*
+
+## System requirements
+
+- [node](http://nodejs.org/) v0.2.5 or compatible
+- [node-amqp](https://github.com/ry/node-amqp) v0.0.2 or compatible
+- [node-irc](https://github.com/martynsmith/node-irc) v0.1.2 or compatible
+