diff --git a/README.md b/README.md index dc7fe71..1575795 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,21 @@ # Beer Api -Beer api est une application de notations de biere. +Beer api est une application de notation de bières. ## Description -Cette application permet a des utilisateurs de rentrer une note pour une biere lorsqu'il la deguste. +Cette application permet à des utilisateurs de saisir une note pour une bière lorsqu'il la déguste. -Cette api permet aussi de trouver des biere sen fonction de leur degre d'alcool ou d'amertume. +Cette api permet aussi de trouver des bières en fonction de leur degré d'alcool ou d'amertume. Les specifications se trouvent dans le dossier `doc/spec`. -**Prerequis** -> Docker et docker compose doivent etre installer sur la machine +**Pré-requis** +> Docker +> Docker compose +> Make -> Make aussi doit etre installer +Pour lancer l'initialisation de la stack, faire un `make setup`. Les conteneurs seront construits et demarrés. +Une fois lancé, `make vendor` provisionnera les vendors. -Pour lancer l'initialisation de la stack faire un make setup, les conteneur seront construit et demarrer. -une fois lander make vendor provisionnera les vendors. - -Pour avoir plus d'informations sur les differentes commande disponible avec make juste faire `make` +Pour avoir plus d'informations sur les differentes commandes disponibles avec make, executez `make`.