chronicle_bot/wiki/addons.md
Bill Niblock c10b847e81 Add Yard, and begin some documentation
Use Yard to generate documentation. Included in the `.yardopts` file is
configuration to also publish the markdown files in the `wiki/`
directory.

wiki/
- addons.md: Information on writing new addons.
- database.md: Information on using the database and migrations

db/migrate/*: Rename in accordance with documentation

Rakefile: Add the Yard Rake tasks
2021-03-07 16:57:27 -05:00

19 lines
447 B
Markdown

# @markup markdown
# @title Add-Ons
# Chronicle Add-ons
Add-ons represent functionality that may not be universally enabled or desired
by default. Provided examples include a dice roller, a custom command handler,
and some simple games.
Writing an add-on for Chronicle is relatively straight forward, and being
refined as I develop it more.
## Creating an Add-on
### General requirements
### Protocol requirements
### Database requirements