decentral1se/xbotlib
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Take another pass on the docs

Browse Source
This commit is contained in:
Luke Murphy 2021-01-16 22:08:59 +01:00
parent f117a38bef
commit a6c30e49af
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -113,7 +113,7 @@ See more in the [commands](#commands) section on how to use this.
## Commands ## Commands
Using `!<command>` in direct messages and `<nick>, @<command>` in group chats, Using `@<command>` in direct messages and `<nick>, @<command>` in group chats,
here are the supported commands. here are the supported commands.
- **@uptime**: how long the bot has been running - **@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 will generate a configuration for you by asking a few questions. This is the
simplest way to run your bot locally. 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 ### Using the command-line interface
Every bot accepts a number of comand-line arguments to load configuration. You 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_ROOMS**: The rooms to automatically join
- **XBOT_NO_AUTO_JOIN**: Disable auto-joining on invite - **XBOT_NO_AUTO_JOIN**: Disable auto-joining on invite
## Deploy your bots
See [bots.varia.zone](https://bots.varia.zone/).
## Persistent storage ## Persistent storage
## Redis key/value storage ## Redis key/value storage
@ -201,6 +207,10 @@ class MyBot(Bot):
plugins = ["xep_0066"] plugins = ["xep_0066"]
``` ```
## Deploy your bots
See [bots.varia.zone](https://bots.varia.zone/).
## Roadmap ## Roadmap
See the [issue tracker](https://git.autonomic.zone/decentral1se/xbotlib/issues). See the [issue tracker](https://git.autonomic.zone/decentral1se/xbotlib/issues).