2 files changed, 99 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100755
index 0000000..897bca0
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,63 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+venv/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# .idea
+.idea
+bot\.cfg
diff --git a/README.MD b/README.MD
new file mode 100755
index 0000000..4fc3196
--- /dev/null
+++ b/README.MD
@@ -0,0 +1,36 @@
+# Python XMPP Chatbot
+
+## beforehand
+Do not opperate this bot on foreign servers.
+
+### 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)
+- displaying a help output
+- respond to username being mentioned
+
+### todo
+- [ ] query xmpp server contact addresses [XEP-0157](https://xmpp.org/extensions/xep-0157.html)
+  - [x] iq is being catched but the answer needs to be extracted out of it
+- [ ] Github Webhook
+
+### install
+#### requirements
+- slixmpp
+- configparser
+- datetime
+- random
+
+#### configuration
+`bot.cfg` replace dummy file with correct credentials/ parameters
+````cfg
+[Account]
+jid=nick@domain.tld/querybot-0.1
+password=super_secret_password
+[MUC]
+rooms=room_to_connect_to@conference.domain.tld
+nick=mucnickname
+[ADMIN]
+admins=admins ( ! muc nick and not the jid nickname)
+````
+ If done correctly `./main.py &` and enjoy your bot.
+\ No newline at end of file