Cronocide/bluebubbles-bot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
Daniel Dayley 2023-04-10 15:14:28 -06:00
parent 7b913d3642
commit 0444be965b
Signed by: Cronocide
GPG Key ID: 2CB7D4B8DEB3198E
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -4,13 +4,24 @@
![Build Status](https://jenkins.cronocide.net/job/git.cronocide.net/job/bluebubbles-bot/job/master/badge/icon?subject=Jenkins%20Build)
## Usage
```
usage: bluebubbles_bot [-h] [-l LOG] [-v]
optional arguments:
-h, --help show this help message and exit
-l LOG, --log LOG Specify a file to log to.
-v, --verbose Include verbose information in the output. Add 'v's for more output.
Example:
bluebubbles_bot -h
```
bluebubbles_bot loads instances of the `PersonaSkill` class from python files in the [skills](/skills) folder.
You may configure the skill by specifying `startup` and `shutdown` functions to configure your skills as required.
It will be helpful to follow the examples in the [skills](/skills) folder for designing your skills for the bot.
## Installation
1.
@ -19,6 +30,8 @@
## Configuration
The following environment variables must be set to configure the bot:
```
```