From 6d057c1c3b8ed88f85e9e43d21950ca6412d78f8 Mon Sep 17 00:00:00 2001 From: Niklas Amundsson Date: Sun, 6 Jul 2025 22:15:57 +0200 Subject: [PATCH] update readme --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 68ad127..7f8106c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,16 @@ # AniList Discord Bot A [UNOFFICIAL] Discord bot to search the AniList website and get release reminders. It started off as a fork of the [AniList/discord-search-bot](https://github.com/AniList/discord-search-bot) repository. -## Usage +## Installation + +### Requirements +- Node v24.0.0 or higher (not tested on below versions) +- A Discord developer account + +### Getting Started +1. Clone this repo and run `yarn install` +2. Create a copy of `.env.example` named `.env` +3. Go to the [Discord Developer Portal](https://discordapp.com/developers/applications/) and create an application +4. Go to the "Bot" page and click "Add a bot" +5. Copy the token created for your bot and paste it into the `TOKEN` value in your `.env` file +6. Run `yarn startClean` \ No newline at end of file