diff --git a/README.md b/README.md index 91a8455..e4b2bda 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,51 @@ `sendxmpp.py` is the XMPP equivalent of sendmail. It is an alternative to the old sendxmpp written in Perl. -Dependency: [sleekxmpp](https://github.com/fritzy/SleekXMPP) (python3 version) +# Dependencies + + This requires Python 3.X +``` +sudo apt-get install python3 +``` -Installation: just put the scripts wherever you want. +Install dnspython + ``` + wget https://github.com/rthalley/dnspython/archive/v1.11.1-py3.tar.gz + + tar xvf v1.11.1-py3.tar.gz + + cd dnspython-1.11.1-py3/ + + sudo python3 setup.py install --record files.txt + + cd ../ + ``` + +Install SleekXMPP + ``` + git clone https://github.com/fritzy/SleekXMPP + + cd SleekXMPP/ + + sudo python3 setup.py install + + cd ../ + ``` + + Installation: just put the scripts wherever you want. + Configuration: see `CONFIG.example`, default config path is `~/.xmpputils` +``` +cp CONFIG.example `~/.xmpputils +``` +Edit `~/.xmpputils` with your xmpp credentials. + +Usage: (assuming you're in xmpputils/) +``` + echo "This is a test" | ./sendxmpp.py user@host +``` + +``` +./sendxmpp.py < README.md user@host +```