From 61e658b573a5d5370fa12bf75b5633ed9db2fbee Mon Sep 17 00:00:00 2001 From: Noikoio Date: Sun, 15 Oct 2017 20:17:36 -0700 Subject: [PATCH] Added documentation index (as a test) --- docs/docs/index.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 docs/docs/index.md diff --git a/docs/docs/index.md b/docs/docs/index.md new file mode 100644 index 0000000..982a197 --- /dev/null +++ b/docs/docs/index.md @@ -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). \ No newline at end of file