Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
giovannimin committed Mar 30, 2024
1 parent ce0edca commit 5da554c
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,11 @@ Pour utiliser ce projet en local :

git clone https://github.com/giovannimin/TellMeMoreAbout.git


### Pré-requis
Pour installer les dépendances de ce projet


pip install requirements.txt


Expand All @@ -45,16 +47,19 @@ Ce projet est destiné à être utilisé via différents modes :

curl -o path/${player_name}_report.png -X GET http://localhost:8000/status/${player_name}


- Une utilisation locale via la CLI


python3 ./src/main.py $player_name


- Une application executable avec Docker


docker-compose -f TellMeMoreAbout/docker_app/docker-compose.yml up --build


- Une utilisation automatisée contrôlée par des bots [X | Twitter](https://twitter.com)

### Exemple d'utilisation
Expand All @@ -66,11 +71,14 @@ Pour cet exemple, nous allons requêter le rapport comparatif de [Bradley Barcol


curl -o barcola_report.png -X GET http://localhost:8000/status/$barcola


- CLI :


python3 ./src/main.py $barcola


#### Objet
Le comportement de l'application est le suivant :
```bash
Expand Down Expand Up @@ -175,7 +183,7 @@ Pour plus d'informations sur les façons dont vous pouvez contribuer à ce proje
sur GitHub, en ouvrant une **[New Issue](https://github.com/giovannimin/TellMeMoreAbout/issues/new)** ou en laissant un message via la **[Discussion](https://github.com/giovannimin/TellMeMoreAbout/discussions/1)**.


Si vous avez besoin de plus d'information sur les contributions open-source,
Si vous avez besoin de plus d'informations sur les contributions open-source,
**[ce guide](https://opensource.guide/how-to-contribute/)** explique pourquoi et comment vous impliquer.


Expand Down

0 comments on commit 5da554c

Please sign in to comment.