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,31 +2,47 @@
An open-source bot which helps you to choose best swords for fishes around the world. 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 ## Usage
TODO:tm: TODO:tm:
## Installation ## Installation
1. Clone the repository. 1. Install required dependencies (Tesseract, MongoDB)
2. Install Tesseract
> Tesseract works on Linux way better than Windows, but oh well. 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. 3. Set up your MongoDB database.
> The free tier in MongoDB Atlas is NOT enough as it is limited to 500 entries only. > 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: 4. Set up the required environment variables, which contains these variables:
```bash
# Putting all of these into a .env file is fine. ```bash
DISCORD_TOKEN=<token> # Putting all of these into a .env file is fine.
MONGODB_URL=<mongodb url> DISCORD_TOKEN=<token>
# Optional, only if the url doesn't contain a username. MONGODB_URL=<mongodb url>
MONGODB_USERNAME=<mongodb username> # Optional, only if the url doesn't contain a username.
# Optional, only if the url doesn't contain a password. MONGODB_USERNAME=<mongodb username>
MONGODB_PASSWORD=<mongodb password> # Optional, only if the url doesn't contain a password.
``` MONGODB_PASSWORD=<mongodb password>
```
5. Start the bot: 5. Start the bot:
```bash ```bash
cargo run cargo run
``` ```
## FAQ ## FAQ