aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGustav Sörnäs <gustav@sornas.net>2020-11-13 16:05:00 +0100
committerGustav Sörnäs <gustav@sornas.net>2020-11-13 16:07:02 +0100
commitff0a5c418dc163798492eaf31f21b7db2ba05b66 (patch)
tree228fbdbfcc184149c4214057408186847374cde0 /README.md
parent00491c8005fe75a8cdf9dc06288affd2ec50fb61 (diff)
downloadkodapa-ff0a5c418dc163798492eaf31f21b7db2ba05b66.tar.gz
update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index 60e419f..af3bb39 100644
--- a/README.md
+++ b/README.md
@@ -30,13 +30,15 @@ In order to actually use the bot you need:
- A Discord bot user
- Necessary permissions to add bots to your Slack workspace and Discord server
-Then, either pass the bot tokens as enviornment variables (`DISCORD_API_TOKEN` and
-`SLACK_API_TOKEN`), or hard-code them into the binary (**NOT RECOMMENDED**
+Then, either pass the bot tokens as enviornment variables (`DISCORD_API_TOKEN`
+and `SLACK_API_TOKEN`), or hard-code them into the binary (**NOT RECOMMENDED**
except for development purposes) by editing `src/discord.rs` and `src/slack.rs`.
Which channels the messages are sent to is currently specified via either
hard-coded constant values (again, not recommended, but at least not a security
-issue here) or environment variables (`DISCORD_CHANNEL` and `SLACK_CHANNEL`).
+issue here) or environment variables (`DISCORD_CHANNEL` and `SLACK_CHANNEL`). If
+neither is set the bot will print a list of all channels and their IDs when
+starting so you can specify a channel.
The following shows all necessary steps needed to build and run the bot: