Edit README.md

README.md

@@ -1,7 +1,43 @@
-## API with Strapi
+# API made with Strapi
 
-[Front](https://gitlab.com/cedric-famibelle-pronzola/oki-front)
+## Prérequis
+- Node >=10.16.0 <=14.x.x
+- Npm ou Yarn
+- Mongo 4.x
 
-Organisation KA Internationale
+## Variables d'environnement
+- Copier le contenu du fichier `.env.sample` dans un nouveau fichier `.env`
+```
+cp .env.sample .env
+```
 
-#OKi API
+`STRAPI_URL` sera utile en production uniquement. Cette variable fait référence à l'url du site de production *(exemple : `https://api.mon-site.fr`)*.
+
+`STRAPI_ADMIN_URL` fait référence à la route pour accéder à l'espace d'administration *(exemple : `/api-dashboard`)* .
+
+## Installation des dépendance & lancement du serveur
+
+```
+yarn && yarn build && yarn dev
+```
+
+## Point d'accès
+
+### `/awtis`
+- `GET` : Lister tous les artistes
+
+### `/awtis/{id}`
+- `GET` : Récupérer les informations d'un artiste
+
+### `/awtis/count`
+- `GET` : Récupère le nombre d'artiste
+___
+
+### `/teks`
+- `GET` : Lister tous les textes
+
+### `/teks/{id}`
+- `GET` : Récupérer les informations d'un texte
+
+### `/teks/count`
+- `GET` : Récupère le nombre de texte