aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJacob Janzen <jacob.a.s.janzen@gmail.com>2024-12-30 21:33:22 -0600
committerJacob Janzen <jacob.a.s.janzen@gmail.com>2024-12-30 21:33:22 -0600
commit7af0c460fce1d54a31e004ed797462d647ee6346 (patch)
tree0896fc2591911efb216966d3be134ff391b98b26
parent5d8f9e7f0d69fcdaa320100b4325896faf450f1e (diff)
cleanup readme
-rw-r--r--README.md18
1 files changed, 10 insertions, 8 deletions
diff --git a/README.md b/README.md
index 8aeb8ce..5b11af0 100644
--- a/README.md
+++ b/README.md
@@ -7,14 +7,7 @@ A bot that automates silliness.
1. Create a new bot at https://discord.com/developers/applications/
2. Set your Interactions Endpoint URL here: https://discord.com/developers/applications/<id\>/information
3. Clone the latest version of `sily-bot` with `git clone https://git.jjanzen.ca/index.cgi/sily-bot.git`
-4. Populate your .env file:
-```ini
-APP_ID=<APPLICATION ID>
-DISCORD_TOKEN=<TOKEN>
-PUBLIC_KEY=<PUBLIC KEY>
-TIMEZONE=<TIMEZONE>
-PORT=<PORT> # optional
-```
+4. Populate your `.env` file
* APP_ID and PUBLIC_KEY are found at https://discord.com/developers/applications/<id\>/information
* DISCORD_TOKEN is found by reseting the token at https://discord.com/developers/applications/<id\>/bot
* TIMEZONE is base on the [IANA time zone database](https://www.iana.org/time-zones) e.g. `America/Winnipeg`
@@ -23,6 +16,15 @@ PORT=<PORT> # optional
6. Register the bot commands with `npm run register`
7. Run the bot with `npm run start`
+The `.env` file is formatted as:
+```ini
+APP_ID=<APPLICATION ID>
+DISCORD_TOKEN=<TOKEN>
+PUBLIC_KEY=<PUBLIC KEY>
+TIMEZONE=<TIMEZONE>
+PORT=<PORT> # optional
+```
+
### Note on accessing the bot
This bot requires that there be a publicly accessible interactions endpoint URL. You're on your own for this as the setup entirely depends on your system. I run an Apache webserver that proxies requests for `/sily-bot` to `http://127.0.0.1:3000/` with the following: