From 01aac0a88b0621e2b7d9d2fbe74e60b00ae2d4b2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABl=20Gangloff?= Date: Thu, 2 May 2024 18:27:56 +0200 Subject: [PATCH] docs: add banner --- README.md | 6 +++++- docs/README.hbs | 6 +++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0b5da75..7704db0 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,10 @@ ![GitHub CI](https://github.com/maelgangloff/grdf-api/actions/workflows/CI.yml/badge.svg) [![npm](https://img.shields.io/npm/dm/grdf-api?style=flat-square)](https://npm-stat.com/charts.html?package=grdf-api) +

+ +

+ Support non-officiel de l'API GRDF. Ce module permet de gérer et récupérer la consommation des compteurs communicants Gazpar en utilisant l'API du site de GRDF. Leur site internet étant en perpétuelle mutation, ce module devra être mis à jour régulièrement. @@ -11,8 +15,8 @@ Ce module permet de gérer et récupérer la consommation des compteurs communic > Un wiki est disponible, celui-ci rassemble davantage d'informations sur le fonctionnement de l'API. > **[Ce wiki est disponible ici](https://github.com/maelgangloff/grdf-api/wiki).** +## Disclaimer > [!WARNING] -> ## Disclaimer > - Il est clairement mentionné que cette librairie n'est pas officiellement éditée par GRDF. > - Ce module n'est pas une contrefaçon car il n'existe pas de module similaire édité officiellement. > - Les utilisateurs ne peuvent accéder qu'à leurs propres données. Ils sont soumis au même processus d'authentification que celui implémenté dans l'espace client GRDF et imposé par le serveur API. diff --git a/docs/README.hbs b/docs/README.hbs index f568ad4..81efa36 100644 --- a/docs/README.hbs +++ b/docs/README.hbs @@ -4,6 +4,10 @@ ![GitHub CI](https://github.com/maelgangloff/grdf-api/actions/workflows/CI.yml/badge.svg) [![npm](https://img.shields.io/npm/dm/grdf-api?style=flat-square)](https://npm-stat.com/charts.html?package=grdf-api) +

+ +

+ Support non-officiel de l'API GRDF. Ce module permet de gérer et récupérer la consommation des compteurs communicants Gazpar en utilisant l'API du site de GRDF. Leur site internet étant en perpétuelle mutation, ce module devra être mis à jour régulièrement. @@ -11,8 +15,8 @@ Ce module permet de gérer et récupérer la consommation des compteurs communic > Un wiki est disponible, celui-ci rassemble davantage d'informations sur le fonctionnement de l'API. > **[Ce wiki est disponible ici](https://github.com/maelgangloff/grdf-api/wiki).** +## Disclaimer > [!WARNING] -> ## Disclaimer > - Il est clairement mentionné que cette librairie n'est pas officiellement éditée par GRDF. > - Ce module n'est pas une contrefaçon car il n'existe pas de module similaire édité officiellement. > - Les utilisateurs ne peuvent accéder qu'à leurs propres données. Ils sont soumis au même processus d'authentification que celui implémenté dans l'espace client GRDF et imposé par le serveur API.