From 99c59439cdb87e592438647d0cf86aed624f9c07 Mon Sep 17 00:00:00 2001 From: Alek Ratzloff Date: Wed, 19 Aug 2020 14:13:02 -0700 Subject: [PATCH] Add root 'channels' configuration docs to config.ex and README Signed-off-by: Alek Ratzloff --- README.md | 2 +- lib/config.ex | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e13b9a9..7061ceb 100644 --- a/README.md +++ b/README.md @@ -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")** * `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)** -* `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 [])** * `plugin_paths` - a list of locations to look for additional plugins. **(optional, default [])** diff --git a/lib/config.ex b/lib/config.ex index 129193b..b9165f0 100644 --- a/lib/config.ex +++ b/lib/config.ex @@ -14,6 +14,7 @@ defmodule Omnibot.Config do - 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)** + - 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 [])** - plugin_paths: a list of locations to look for additional plugins. **(optional, default [])**