aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorjjanzen <jjanzen@jjanzen.ca>2025-01-18 15:25:09 -0600
committerjjanzen <jjanzen@jjanzen.ca>2025-01-18 15:25:09 -0600
commitad10e53d0c940b4305681c3b5906fc3c71a7283b (patch)
treef63dc72bbbe4bbf3ae21b466c550dd8e9e705906 /README.md
parentbcaa230abd1d69bcd5523731f71a6cb0e01b17c2 (diff)
clean up readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index 3b46ffe..60de45e 100644
--- a/README.md
+++ b/README.md
@@ -4,14 +4,14 @@ A bot that automates silliness.
## How to run
-1. Create a new bot at https://discord.com/developers/applications/
+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
- * 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
+ * `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`
- * PORT is the port that the application should run on. This value is optional and defaults to 3000.
+ * `PORT` is the port that the application should run on. This value is optional and defaults to 3000.
5. Install dependencies with `npm install`
6. Register the bot commands with `npm run register`
7. Run the bot with `npm run start`