Added documentation index (as a test)
This commit is contained in:
parent
4557c2fdb7
commit
61e658b573
1 changed files with 11 additions and 0 deletions
11
docs/docs/index.md
Normal file
11
docs/docs/index.md
Normal file
|
@ -0,0 +1,11 @@
|
||||||
|
# Documentation
|
||||||
|
On its own, RegexBot has no default behavior. It is up to the user to define everything, including triggers and commands for use by moderators.
|
||||||
|
|
||||||
|
Configuration takes the form of a JSON file name `settings.json`. Within this file should be one object, which itself contained named values.
|
||||||
|
|
||||||
|
[Sample file for quick reference.](sample.html)
|
||||||
|
|
||||||
|
Here is a list of all accepted values.
|
||||||
|
* bot-token (*string*) - **Required.** Discord token used for connecting to the service.
|
||||||
|
* playing (*string*) - String to display as the bot's "now playing" status message.
|
||||||
|
* servers (*array*) - Takes an array of [server definitions](serverdef.html).
|
Loading…
Reference in a new issue