diff --git a/README.md b/README.md index 1d54878..e276e19 100644 --- a/README.md +++ b/README.md @@ -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: + ``` ```