diff --git a/README.md b/README.md index 8b4f28c..2bfbbcf 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,10 @@ that exposes functions such as `message_handler` that can parse and react to messages. +## Supported XEPs + +- Implements [XEP-0084: User Avatar](https://xmpp.org/extensions/xep-0084.html) for uploading the bot's avatar image and sharing online status through [XEP-0060: Publish-Subscribe](https://xmpp.org/extensions/xep-0060.html#subscriber-subscribe-request) and [XEP-0163: PEP](https://xmpp.org/extensions/xep-0163.html). + ## Building and running the XMPP bot Requires `make`, `libstrophe` and `libssl` to be installed. See the `makefile` in the root directory of this repository. @@ -18,12 +22,12 @@ This will compile an executable `./bin/xmpp-bot` that can be run with the appropriate CLI variables, such as: ```sh -./bin/xmpp-bot +./bin/xmpp-bot ``` ### Debugging -`make debug` will compile `./bin/debug/xmpp-bot` with `-g` debug flags turned on and optimization turned off. +`make debug` will compile `./bin/debug/xmpp-bot` with `-g` debug flags turned on, debug logging and optimization turned off. ## Running the pyhton report script