intercal/omnibot
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix formatting for configuration docs in config.ex and README

Browse Source 
Signed-off-by: Alek Ratzloff <alekratz@gmail.com>
This commit is contained in:
Alek Ratzloff
2020-08-19 14:14:47 -07:00
parent 99c59439cd
commit cd16b20270
2 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -43,15 +43,15 @@ in the project root. Changing the configuration file can be done setting the env
## Configuration keys ## Configuration keys
* `server` - the IRC server to connect to. **(required)** * `server` - the IRC server to connect to. (required)
* `nick` - the IRC nickname to use for the bot. **(optional, default "omnibot")** * `nick` - the IRC nickname to use for the bot. (optional, default `"omnibot"`)
* `user` - the IRC username to use for the bot. **(optional, default "omnibot")** * `user` - the IRC username to use for the bot. (optional, default `"omnibot"`)
* `real` - the IRC realname to use for the bot. **(optional, default "omnibot")** * `real` - the IRC realname to use for the bot. (optional, default `"omnibot"`)
* `port` - the port to connect to the server on. **(optional, default 6667)** * `port` - the port to connect to the server on. (optional, default `6667`)
* `ssl` - whether to use SSL or not. Note that IRC usually uses port 6697 for SSL. **(optional, default false)** * `ssl` - whether to use SSL or not. Note that IRC usually uses port 6697 for SSL. (optional, default `false`)
* `channels` - a list of channels that the bot should always join. **(optional, default [])** * `channels` - a list of channels that the bot should always join. (optional, default `[]`)
* `plugins` - a list of plugins to load and their configuration. **(optional, default [])** * `plugins` - a list of plugins to load and their configuration. (optional, default `[]`)
* `plugin_paths` - a list of locations to look for additional plugins. **(optional, default [])** * `plugin_paths` - a list of locations to look for additional plugins. (optional, default `[]`)
### Plugin configuration ### Plugin configuration

18
lib/config.ex
View File

@@ -7,16 +7,16 @@ defmodule Omnibot.Config do
## Configuration keys ## Configuration keys
- server: the IRC server to connect to. **(required)** - server: the IRC server to connect to. (required)
- nick: the IRC nickname to use for the bot. **(optional, default "omnibot")** - nick: the IRC nickname to use for the bot. (optional, default `"omnibot"`)
- user: the IRC username to use for the bot. **(optional, default "omnibot")** - user: the IRC username to use for the bot. (optional, default `"omnibot"`)
- real: the IRC realname to use for the bot. **(optional, default "omnibot")** - real: the IRC realname to use for the bot. (optional, default `"omnibot"`)
- port: the port to connect to the server on. **(optional, default 6667)** - port: the port to connect to the server on. (optional, default `6667`)
- ssl: whether to use SSL or not. Note that IRC usually uses port 6697 for - ssl: whether to use SSL or not. Note that IRC usually uses port 6697 for
SSL. **(optional, default false)** SSL. (optional, default `false`)
- channels: a list of channels that the bot should always join. **(optional, default [])** - channels: a list of channels that the bot should always join. (optional, default `[]`)
- plugins: a list of plugins to load and their configuration. **(optional, default [])** - plugins: a list of plugins to load and their configuration. (optional, default `[]`)
- plugin_paths: a list of locations to look for additional plugins. **(optional, default [])** - plugin_paths: a list of locations to look for additional plugins. (optional, default `[]`)
## Plugins configuration ## Plugins configuration