From 65449b763c4b9bb08d4fd15551118fccd2a00b06 Mon Sep 17 00:00:00 2001
From: John Reese <jreese@leetcode.net>
Date: Thu, 13 Jan 2011 21:17:13 -0500
Subject: [PATCH] Added readme

---
 README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f43d58a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+ZNC to Notifo
+=============
+
+ZNC to Notifo is a module for [znc][] that will send notifications to a [notifo][] account
+for any private message or channel highlight that matches a configurable set of conditions.
+
+
+Compiling
+---------
+
+If you have `make` installed, you can compile the module with:
+
+    $ make
+
+Otherwise, run the full command:
+
+    $ znc-build notifo.cpp
+
+
+Installation
+------------
+
+Copy the compiled module into your ZNC profile:
+
+    $ cp notifo.so ~/.znc/modules/
+
+Now, load the module in ZNC:
+
+    /msg *status loadmod notifo
+
+Then set your Notifo username and API secret:
+
+    /msg *notifo set username foo
+	/msg *notifo set secret ...
+
+At this point, it should start sending notifications every time you get a private message
+or someone says your name in a channel.  If this is everything you wanted, congratulations,
+you're done!  If you want to tweak the notfication conditions, continue on to configuration.
+
+
+Configuration
+-------------
+
+There is none yet.... :'(
+
+
+License
+-------
+
+This project is licensed under the MIT license.  See the `LICENSE` file for details.