Merge pull request #5 from mightyBroccoli/dev

readme + usability improvements

README.MD

@@ -1,28 +1,35 @@
 # Python XMPP Chatbot
 
 ## beforehand
-Do not opperate this bot on foreign servers.
+Do not operate this bot on foreign servers. Many servers prohibit the usage of bots on their service.
 
 ### functions
 - query xmpp server software and version [XEP-0092](https://xmpp.org/extensions/xep-0092.html)
 - query xmpp server uptime [XEP-0012](https://xmpp.org/extensions/xep-0012.html)
 - query xmpp server contact addresses [XEP-0157](https://xmpp.org/extensions/xep-0157.html)
+- display information about XEP from the [XSF extensions website](https://xmpp.org/extensions/)
 - display help output
 - respond to username being mentioned
 
 ### install
-#### requirements
+#### virtualenv
-- slixmpp
+With virtualenv it is possible to run the bot inside a virtual environment without disrupting other python processes
-- logging
+ and or dependencies. This repo comes with a `requirements.txt` to make the install process as easy as possible.
-- ssl
+ ````bash
-- configparser
+cd to_the_path/of_the_bot/
-- validators
+mkdir ./venv
+
+# create the virtual environment
+virtualenv -p $(which python3) ./venv
+source ./venv/bin/activate
+pip3 install -r requirements.txt
+````
 
 #### configuration
-`bot.cfg` replace dummy file with correct credentials/ parameters
+Replace the dummy `bot.cfg` file, filled with correct credentials/ parameters.
 ````cfg
 [Account]
-jid=nick@domain.tld/querybot-0.1
+jid=nick@domain.tld/querybot
 password=super_secret_password
 [MUC]
 rooms=room_to_connect_to@conference.domain.tld,another_room@conference.domain.tld

requirements.txt

@@ -0,0 +1,4 @@
+slixmpp>=1.2.2
+defusedxml>=0.5.0
+requests>=2.19.1
+validators>=0.12.2