Manuel à jour

This commit is contained in:
F. Y. H. 2021-10-05 23:04:40 +02:00
parent 172f73b5ba
commit 333efed3f1

View file

@ -2,3 +2,35 @@
Projet de bot en *Bash* pour *Revolt*. Projet de bot en *Bash* pour *Revolt*.
…Un peu de *Python* aussi. …Un peu de *Python* aussi.
Si `revolt_bot.sh` est exécutable laide est disponible comme suit :
```bash
revolt_bot.sh --help
```
## Dépendances
Ce petit bot en *Bash* dépend de deux outils :
### *cURL*
*cURL* permet de communiquer avec lAPI de *Revolt* (un serveur *Revolt Delta*) via le HTTP.
Pour linstaller via `apt` :
```bash
sudo apt install curl
```
### *Py-ULID*
*Py-ULID* permet de générer des codes de type ULID sous forme de 26 caractères.
Pour linstaller via `pip` :
```bash
pip install py-ulid
```
## Usage
Pour envoyer un message `MESSAGE` via son bot le jeton didentification `BOT_TOKEN` et lidentifiant du salon `CHANNEL_ID` sont nécessaires.
```bash
revolt_bot.sh -t $BOT_TOKEN -c $CHANNEL_ID -m $MESSAGE
```