diff --git a/README.md b/README.md index 5261850..8b7921f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# PronoteApi +# PronoteBot -PronoteApi est un projet conçu pour faciliter la récupération des notes Pronote et envoyer des mises à jour à un webhook. Il utilise la bibliothèque [pronotepy](https://github.com/bain3/pronotepy) pour les interactions avec Pronote. +PronoteBot est un projet conçu pour faciliter la récupération des notes Pronote et envoyer des mises à jour à un webhook. Il utilise la bibliothèque [pronotepy](https://github.com/bain3/pronotepy) pour les interactions avec Pronote. ## Dépendances @@ -10,13 +10,13 @@ PronoteApi est un projet conçu pour faciliter la récupération des notes Prono ## Utilisation -Pour utiliser PronoteApi, suivez ces étapes : +Pour utiliser PronoteBot, suivez ces étapes : 1. Clonez le dépôt : ```bash - git clone https://github.com/NohamR/PronoteApi.git - cd PronoteApi + git clone https://github.com/NohamR/PronoteBot.git + cd PronoteBot ``` 2. Installez les dépendances : @@ -37,7 +37,7 @@ Pour utiliser PronoteApi, suivez ces étapes : Pour avoir le nom de votre ent : [ici](https://pronotepy.readthedocs.io/en/stable/api/ent.html), par exemple : ile_de_france. -4. Exécutez le script PronoteApi : +4. Exécutez le script PronoteBot : ```bash python3 getgrades.py @@ -46,19 +46,19 @@ Pour avoir le nom de votre ent : [ici](https://pronotepy.readthedocs.io/en/stabl ## Docker -Vous pouvez également construire et exécuter PronoteApi en tant que conteneur Docker. Utilisez les configurations Dockerfile et docker-compose.yaml suivantes : +Vous pouvez également construire et exécuter PronoteBot en tant que conteneur Docker. Utilisez les configurations Dockerfile et docker-compose.yaml suivantes : ### Dockerfile -Le fichier Dockerfile est disponible [ici](Dockerfile). Assurez-vous de le placer à la racine du répertoire PronoteApi. +Le fichier Dockerfile est disponible [ici](Dockerfile). Assurez-vous de le placer à la racine du répertoire PronoteBot. -Pour construire l'image Docker, exécutez la commande suivante à la racine du répertoire PronoteApi : +Pour construire l'image Docker, exécutez la commande suivante à la racine du répertoire PronoteBot : - docker build -t pronoteapi:latest . - docker run -d pronoteapi:latest + docker build -t PronoteBot:latest . + docker run -d PronoteBot:latest ### docker-compose.yaml -Le fichier docker-compose.yaml est disponible [ici](docker-compose.yaml). Assurez-vous de le placer à la racine du répertoire PronoteApi. +Le fichier docker-compose.yaml est disponible [ici](docker-compose.yaml). Assurez-vous de le placer à la racine du répertoire PronoteBot. - docker-compose up -d \ No newline at end of file + docker-compose up -d