updated the readme to have setup documentation

README.md

@@ -1,3 +1,22 @@
 # znc-xmpp-notify
 
-ZNC module to notify of pings over XMPP.
+ZNC module to notify of pings over XMPP.
+
+## Dependencies
+
+- ZNC modpython
+- sendxmpp
+
+## Setup
+### Set up sendxmpp (administrator)
+
+1. Create an XMPP account for your ZNC instance's notification bot.
+2. Put the JID and password in ~/.sendxmpprc in the format `<user@host> <password>`
+3. Make sure modpython is available
+
+### Set up module (user)
+
+1. This may not be necessary, but load modpython: `/msg *status loadmod modpython`
+2. Load xmppnotify.py, with your preferred JID as the argument: `/msg *status loadmod xmppnotify <user@host>`
+3. Enjoy.
+

xmppnotify.py

@@ -2,7 +2,7 @@ import znc
 import subprocess
 
 class xmppnotify(znc.Module):
- description = "XMPP notification module; just a test so far."
+ description = "XMPP notification module"
  has_args = True
  args_help_text = "XMPP address."
  module_types = [znc.CModInfo.UserModule]