up readme

README.md

@@ -4,25 +4,16 @@ Script nodejs permettant de lire un flux RSS présentant des évènements et de
 
 Veillez à bien configurer les accès postgres dans la config du script.
 
-Actuellement ce script permet d'importer depuis:
+# Installation
+Configurez les informations de connexion dans le fichier __config.ts__
 
-- l'agenda du libre
-
----
-
-source: un flux rss de l'agenda du libre, filtré sur les évènements ayant le tag "openstreetmap".
-
-```
-https://www.agendadulibre.org/events.rss?tag=openstreetmap
-```
-
----
-
-projet en nodejs, pour le faire fonctionner, installer les node modules avec
+Ce projet utilise nodejs version 16+ et typescript, pour le faire fonctionner, installer les node modules avec:
 
 ```
 npm i
 ```
+Pour comparer les évènements à ajouter et ceux déjà enregistrés, on se connecte à la BDD postgresql de l'installation mobilizon.
+
 
 ajouter un cronjob qui exécute régulièrement (une fois par jour)
 
@@ -30,6 +21,40 @@ ajouter un cronjob qui exécute régulièrement (une fois par jour)
 ts-node importers/adl.ts
 ```
 
+## Sources d'import
+Actuellement ce script permet d'importer depuis les sites web suivants:
+### L'OSM Calendar
+- En cours de réalisation
+
+### l'agenda du libre
+ Prototype fonctionnel, manque les imports de coordonnées géographique ainsi que les url de site web correspondant à l'évènement.
+Pour s'en servir il faut d'abord récupérer un fichier json qui sera ensuite lu et importé, un par un, toutes les secondes.
+
+Récupération des évènemnts en JSON: 
+`
+ts-node scrapers/ccpl.js
+`
+
+---
+
+source: - un flux rss de l'agenda du libre, filtré sur les évènements ayant le tag "openstreetmap".
+```
+https://www.agendadulibre.org/events.rss?tag=openstreetmap
+```
+
+- un json de l'API en json
+  ```
+https://www.agendadulibre.org/events.json
+```
+qui peut être personnalisé avec des query parameters
+  ```
+https://www.agendadulibre.org/events.json?city=&near%5Blocation%5D=&near%5Bdistance%5D=&region=&tag=openstreetmap
+```
+
+  
+---
+
+
 # Example de requête
 
 Les examples sont mis dans le dossier mocks