Update README.md

README.md

@@ -1,10 +1,25 @@
-# PACA-API
+# Sitourisme (PACA-API)
 
-Outil nécéssaire :
-- NodeJS 14+
-- Docker et docker-compose
+Passerelle permettant d'importer automatiquement des itinéraires depuis l'API d'instances Geotrek-admin vers Apidae.
+
+- Fonctionnement et correspondance des champs : https://geotrek.ecrins-parcnational.fr/ressources/technique/2022-04-Geotrek-Apidae-v2.pdf
+- Présentation aux rencontres Geotrek 2021 : https://geotrek.ecrins-parcnational.fr/rencontres/2021/presentations/09-geotrek-apidae.pdf
+
+Afin de mettre en place la passerelle, il est nécessaire :
+- de créer un projet d'API en écriture sur la plateforme Apidae en indiquant les prestataires
+- de fournir les éléments suivants :
+  - URL du flux API Geotrek
+  - Numéro du projet créé sur la plateforme Apidae avec envoi des clef et secret Oauth
+  - Pour chaque identifiant de structure Geotrek, fournir l'identifiant de l'ENT correspondant dans Apidae 
+
+Version 1 financée par la [Région Sud](https://www.maregionsud.fr), développée par [IDfr](https://www.idfr.net) et [MEDIACTEURS](https://www.mediacteurs.com).
+
+## Installation
 
-## installation
+Outils nécessaires :
+
+- NodeJS 14+
+- Docker et Docker-compose
 
 Créer la structure de dossier comme indiqué dans l'arbre en dessous :
 
@@ -17,18 +32,21 @@ Créer la structure de dossier comme indiqué dans l'arbre en dessous :
     ├── region.csv
 ```
 
-Les fichiers town.csv et region.csv se trouve dans le dossier data du projet, il faut les déplacer au bon endroit.
+Les fichiers `town.csv` et `region.csv` se trouvent dans le dossier `data` du projet, il faut les déplacer au bon endroit.
 
 Dans le projet effectuer la commande d'installation : 
 
+```
 npm install
 ```
 
 ## Usage
 
-Afin de procéder à l'import des données il faut créer un compte utilisateur et intialiser le système d'import, 
-pour cela se rendre sur cette page `http://localhost:3003/authentication/signup` et remplir le formulaire
+Afin de procéder à l'import des données, il faut créer un compte utilisateur et initialiser le système d'import, 
+pour cela se rendre sur cette page `http://localhost:3003/authentication/signup` et remplir le formulaire.
 
 Effectuer ensuite à commande `npm run init-import`
 
-Les imports peuvent maintenant être effectué depuis l'interface.
+Les imports peuvent maintenant être effectués depuis l'interface, ou n accédans directement à l'adresse `http://URL/products/import/geotrek`
+
+Les imports peuvent aussi être lancés automatiquement avec la commande `curl "URL/api/products/import?type=geotrek"`