diff --git a/README.md b/README.md index aa11002..eda8751 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,7 @@ See more in the [commands](#commands) section on how to use this. ## Commands -Using `!` in direct messages and `, @` in group chats, +Using `@` in direct messages and `, @` in group chats, here are the supported commands. - **@uptime**: how long the bot has been running @@ -141,6 +141,16 @@ If you run simply run your Python script which contains the bot then `xbotlib` will generate a configuration for you by asking a few questions. This is the simplest way to run your bot locally. +Here is an example of a working configuration. + +```conf +[echobot] +account = echobot@vvvvvvaria.org +password = ...thepassword... +nick = echobot +rooms = test@muc.example.com +``` + ### Using the command-line interface Every bot accepts a number of comand-line arguments to load configuration. You @@ -161,10 +171,6 @@ deployments. - **XBOT_ROOMS**: The rooms to automatically join - **XBOT_NO_AUTO_JOIN**: Disable auto-joining on invite -## Deploy your bots - -See [bots.varia.zone](https://bots.varia.zone/). - ## Persistent storage ## Redis key/value storage @@ -201,6 +207,10 @@ class MyBot(Bot): plugins = ["xep_0066"] ``` +## Deploy your bots + +See [bots.varia.zone](https://bots.varia.zone/). + ## Roadmap See the [issue tracker](https://git.autonomic.zone/decentral1se/xbotlib/issues).