adelorenzo/stable
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs adjusted; various fixes to bot-usage.md and configuration.md

Browse Source
This commit is contained in:
hroff-1902
2019-08-13 00:10:33 +03:00
parent 90b75afdb1
commit 482847a994
2 changed files with 23 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/configuration.md
View File

@@ -1,15 +1,24 @@
# Configure the bot
This page explains how to configure your `config.json` file.
This page explains how to configure your configuration file.
## Setup config.json
Per default, the bot loads configuration from the `config.json` file located in the current working directory.
You can change the configuration file used by the bot with the `-c/--config` option.
We recommend to copy and use the `config.json.example` as a template
If you used the [Quick start](installation.md/#quick-start) method for installing
the bot, the installation script should have already created the default configuration file (`config.json`) for you.
We recommend you to copy and use the `config.json.example` as a template
for your bot configuration.
The table below will list all configuration parameters.
The configuration file defines the set of configuration parameters for the bot written in the JSON format.
Additionally, you may use one-line `// ...` and multi-line `/* ... */` comments.
Mandatory Parameters are marked as **Required**.
## Configuration parameters
The table below will list all configuration parameters available.
Mandatory parameters are marked as **Required**.
| Command | Default | Description |
|----------|---------|-------------|