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

Add root 'channels' configuration docs to 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:13:02 -07:00
parent 74fc04fa63
commit 99c59439cd
2 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -49,7 +49,7 @@ in the project root. Changing the configuration file can be done setting the env
* `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` - * `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 [])**

1
lib/config.ex
View File

@@ -14,6 +14,7 @@ defmodule Omnibot.Config do
- 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 [])**
- 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 [])**