From 2fc7e8274e4bf97ade6668f79914a78cb3ab3a32 Mon Sep 17 00:00:00 2001 From: Awiteb Date: Fri, 31 May 2024 19:06:13 +0300 Subject: [PATCH] chore: Update README.md Signed-off-by: Awiteb --- README.md | 39 ++++++++++++++++++--------------------- 1 file changed, 18 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index afc9592..7c2d310 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,29 @@ +
+ +## Why is simple? +Add your API tokens (`Authorization` header) and your bot usernames in the `config.toml` file, and you're ready to go. + +> [!NOTE] +> Check out the `config.toml.example` file to see how to fill the `config.toml` file. > [!WARNING] -> -> Remember to keep this file safe, because anyone can use it to ping your bots. -> Recommended to generate the tokens with `openssl rand -hex 32` or `uuidgen`. +> Remember to keep the `config.toml` file safe, because anyone can use it to ping your bots. -## `bots.txt` file (rename `bots.txt.example` to `bots.txt`) -The `bots.txt` file is where you put your bot usernames, this to make sure to ping the specifics bots only. You can put as many as you want, but make sure to put one in each line. - -for example: -``` -@BotFather -@SomeTestBot -@SomeTestBot -``` - -## `.env` file (rename `.env.example` to `.env`) -You need to fill the variables in it. +## CLI Arguments +- `--config`: The path to the config file. (default: `config.toml`) ## Requirements -- Rust (MSRV 1.68.2) +- Rust (MSRV 1.75.0) - Cargo ## Build @@ -38,7 +35,7 @@ cargo build --release ```bash cargo run --release ``` -Or just run the binary file in `target/release/telepingbot` (Not recommended because the `.env` file) +Or just run the binary file in `target/release/telepingbot` ## Endpoints