From 7af0c460fce1d54a31e004ed797462d647ee6346 Mon Sep 17 00:00:00 2001 From: Jacob Janzen Date: Mon, 30 Dec 2024 21:33:22 -0600 Subject: cleanup readme --- README.md | 18 ++++++++++-------- 1 file 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//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= -DISCORD_TOKEN= -PUBLIC_KEY= -TIMEZONE= -PORT= # optional -``` +4. Populate your `.env` file * APP_ID and PUBLIC_KEY are found at https://discord.com/developers/applications//information * DISCORD_TOKEN is found by reseting the token at https://discord.com/developers/applications//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= # 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= +DISCORD_TOKEN= +PUBLIC_KEY= +TIMEZONE= +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: -- cgit v1.2.3