chore: add some info to the README

This commit is contained in:
tretrauit 2024-01-05 01:35:48 +07:00
parent 3c47a90611
commit 785ebc2655

View File

@ -2,18 +2,34 @@
An open-source bot which helps you to choose best swords for fishes around the world.
## Features
+ Faster than Leg (hopefully)
+ Written in Rust
+ Open source
+ ... more in the future
## Usage
TODO:tm:
## Installation
1. Clone the repository.
2. Install Tesseract
1. Install required dependencies (Tesseract, MongoDB)
There are various way to install them, but so far on Arch Linux you would execute the following commands:
```bash
sudo pacman -S tesseract tesseract-data-eng
yay -S mongodb-bin
# Optional
yay -S mongodb-compass # Manage the database with a GUI
```
> Tesseract works on Linux way better than Windows, but oh well.
2. Clone the repository.
3. Set up your MongoDB database.
> The free tier in MongoDB Atlas is NOT enough as it is limited to 500 entries only.
4. Set up the required environment variables, which contains these variables:
```bash
# Putting all of these into a .env file is fine.
DISCORD_TOKEN=<token>