From b6de096ba6095bb0a5e6bd45576a874559b0dc31 Mon Sep 17 00:00:00 2001 From: Camille Monchicourt Date: Tue, 10 Oct 2023 16:01:44 +0200 Subject: [PATCH] Review README --- readme.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/readme.md b/readme.md index 74dab9f..e051dca 100644 --- a/readme.md +++ b/readme.md @@ -1,13 +1,19 @@ -# Geotrek rando widget +# Geotrek-rando widget Web components of [Geotrek](https://geotrek.fr/).\ You can use a complete app or each component independantly. +- To test and configure the widget: https://geotrekce.github.io/Geotrek-rando-widget/ +- Examples: + - https://www.jurabsolu.fr/decouvrez-territoire-jura/randonnees-forets-vignes-jura/ + - https://www.coeurdujura-tourisme.com/activites-nature-jura-outdoor-loisirs/activites-pleine-nature/ + - https://geotrek.ecrins-parcnational.fr/ressources/technique/2022-test-widget.html + ## Usage -**The api you want to use had to authorize your domain.** +**The Geotrek-admin API you want to use has to authorize the URL of the website where you want to include the widget.** -Copy-paste this inside `` +Copy-paste this inside `` to load static widget files: ```html @@ -15,11 +21,13 @@ Copy-paste this inside `` ``` -## Explore +Then you have to configure the widget to generate the widget code to include in your website. + +## Configure -**The api you want to use had to authorize geotrekce.github.io.** +**The API you want to use has to authorize geotrekce.github.io.** -You can explore Geotrek rando widget and create your own component [here](https://geotrekce.github.io/Geotrek-rando-widget/).\ +You can explore Geotrek-rando widget and create your own component [here](https://geotrekce.github.io/Geotrek-rando-widget/).\ Once you made your component, you can get the code to copy-paste by clicking on _Docs_ then _Show code_. [![](https://geotrek.fr/assets/img/logo_autonomens-h120m.png)](https://datatheca.com/)