From 870cdb20a830911665e5023aea3d8f8e15d501f1 Mon Sep 17 00:00:00 2001 From: Niklas Amundsson Date: Mon, 7 Jul 2025 12:36:46 +0200 Subject: [PATCH] add installation and development info --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7f8106c..ae84aff 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # 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. -## Installation +## Development ### Requirements - Node v24.0.0 or higher (not tested on below versions) @@ -13,4 +13,18 @@ A [UNOFFICIAL] Discord bot to search the AniList website and get release reminde 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 +6. Run `yarn startClean` + +## Installation + +### Requirements +- Docker +- A Discord developer account + +### Getting Started +1. Go to the [Discord Developer Portal](https://discordapp.com/developers/applications/) and create an application +2. Go to the "Bot" page and click "Add a bot" +3. Copy the token created for your bot and use it in step 5 +4. Use the docker-compose.yml +5. Insert your ENV variables +6. Run docker-compose up \ No newline at end of file