commit a07cb3dd0ae4cda7acf8577ff035e253416e42ed
Author: hogwart7 <hogwart7@noreply.localhost>
Date:   Mon Jun 26 12:10:34 2023 +0000

    Add 'Config'

diff --git a/Config.md b/Config.md
new file mode 100644
index 0000000..d9aac55
--- /dev/null
+++ b/Config.md
@@ -0,0 +1,35 @@
+# Config
+
+The example config has enough pre-configuration for you to be able to get the gist of what is going on, but if you need extra help, here is a list of all configurable options. This list may not always be up to date but the example configuration will be. 
+
+All options must be configured at this stage, so if you are unsure what values to input or change, leave them as default (you must change irc.server & irc.channels at a minimum).
+
+IRC
+
+| Variable   | Description | Options/Example |
+| --------   | -------- | ---------- |
+| server     | The IRC server to connect to     | URL or IP |
+| port     | The port which you want to connect to the server on     | Port Number |
+| ssl     | Toggle SSL for the connection to the server     | true/false |
+| channels     | Array list of channels the bot will join | ["#example1", "#example2"] |
+| nickname     | Nickname     | mercury |
+| username     | Username     | mercury | 
+| realname     | Real Name     | git.supernets.org/hogwart7/mercury |
+| autorejoin     | Auto Rejoin if bot is disconnected (this does not include crashes, Docker will handle auto-restarts in that case)    | true/false |
+| floodprotection     | Queue messages to prevent excess flood kicks     | true/false |
+| floodprotectiondelay     | How long to queue messages for if floodprotection is enabled     | Number (milliseconds) |
+
+Feed
+
+| Variable | Description | Options/Example |
+| -------- | ----------- | --------------- |
+| useragent | User agent to use for requests, required to prevent error 403's from some sites. I recommend leaving the default as-is, the Firefox user agent is known good for all uses | Mozilla/5.0 (Macintosh; Intel Mac OS X 13.4; rv:109.0) Gecko/20100101 Firefox/114.0 |
+| body_max_chars | How many main body characters to allow in any one post, to prevent single posts being split in to multiple messages | Number (characters) |
+| time_format | Time format to use for post timestamps | DD MMM YYYY HH:mm:ss ZZ |
+| timezone | IANA time zone to use for post timestamps | GMT (for GMT) or Pacific/Auckland (for other) |
+
+Twitter 
+
+| Variable | Description | Options/Example |
+| -------- | ----------- | --------------- |
+| nitter_instances | Array list of Nitter instances for the bot to cycle through (prevents load on any one instance). Domain name only, the rest is preformatted. | ["nitter.id4.us", "nitter.pufe.org"] |
\ No newline at end of file