update readme

This commit is contained in:
2025-07-06 22:15:57 +02:00
parent 089b4bc78e
commit 6d057c1c3b

View File

@ -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`