added minimal documentation and linksHEADmaster

1 files changed, 23 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..b8798dd
--- /dev/null
+++ b/README
@@ -0,0 +1,23 @@
+This module was built and tested with ejabberd-2.1.5
+
+Useful ressources:
+
+http://www.ejabberd.im/node/5085
+http://www.ejabberd.im/Events%20and%20hooks
+
+http://metajack.im/2008/08/28/writing-ejabberd-modules-presence-storms/
+
+
+I implemented a single, trivial response for register requests according to:
+http://metajack.im/2008/08/28/writing-ejabberd-modules-presence-storms/
+
+To build, simply put the erl in ejabberds src/ directory and run
+
+    ./configure && make
+
+Then put the mod_register_refer.beam to /usr/lib/ejabberd/ebin/ and add the
+this to the ejabberd config file:
+
+{mod_register_refer, [ {url,["https://accounts.spline.de"]} ]},
+
+mod_register itself should be disabled, I did not test the coexistance of both modules.