diff --git a/README.md b/README.md index 7855bff..02b6db9 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,27 @@ +# grdf-api + +[![view on npm](https://img.shields.io/npm/v/grdf-api.svg?style=flat-square)](https://www.npmjs.org/package/grdf-api) +![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. + +> [!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. +> - Les données des utilisateurs ne sont pas davantage exposées puisqu'un utilisateur ne peut accéder qu'à ses propres données. Personne n'a le contrôle sur cette limitation qui est inhérente au fonctionnement de l'API des serveurs de GRDF. +> - Cette librairie ne se suffit pas à elle-même pour fonctionner. Il est nécessaire de l'importer dans un projet et l'utilisateur est le seul responsable de son code et des éventuelles conséquences. +> - Tout utilisateur de cette librairie a *a priori* lu et approuvé l'entièreté du fichier de licence GPLv3 disponible publiquement [LICENSE](https://github.com/maelgangloff/grdf-api/blob/master/LICENSE) ainsi que de ce présent fichier de présentation. +> - Tout utilisateur de cette librairie a *a priori* lu et compris l'entièreté du code de ce projet avant toute utilisation. +> - L'auteur de ce projet n'agit pas en tant qu'intermédiaire de traitement des données au sens du RGPD. Les utilisateurs sont responsables de leur propre conformité au RGPD lors de l'utilisation de cette librairie. Ils doivent s'assurer que leur utilisation de cette librairie est conforme aux exigences du RGPD et de toute autre législation applicable en matière de protection des données. +> - Eu égard l'ensemble de ces remarques, les contributeurs et *a fortiori* l'auteur du projet ne peuvent être tenus responsables de tout dommage potentiel. + ## GRDF -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. - **Kind**: global class * [GRDF](#GRDF) diff --git a/docs/README.hbs b/docs/README.hbs new file mode 100644 index 0000000..d383e1a --- /dev/null +++ b/docs/README.hbs @@ -0,0 +1,22 @@ +# grdf-api + +[![view on npm](https://img.shields.io/npm/v/grdf-api.svg?style=flat-square)](https://www.npmjs.org/package/grdf-api) +![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. + +> [!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. +> - Les données des utilisateurs ne sont pas davantage exposées puisqu'un utilisateur ne peut accéder qu'à ses propres données. Personne n'a le contrôle sur cette limitation qui est inhérente au fonctionnement de l'API des serveurs de GRDF. +> - Cette librairie ne se suffit pas à elle-même pour fonctionner. Il est nécessaire de l'importer dans un projet et l'utilisateur est le seul responsable de son code et des éventuelles conséquences. +> - Tout utilisateur de cette librairie a *a priori* lu et approuvé l'entièreté du fichier de licence GPLv3 disponible publiquement [LICENSE](https://github.com/maelgangloff/grdf-api/blob/master/LICENSE) ainsi que de ce présent fichier de présentation. +> - Tout utilisateur de cette librairie a *a priori* lu et compris l'entièreté du code de ce projet avant toute utilisation. +> - L'auteur de ce projet n'agit pas en tant qu'intermédiaire de traitement des données au sens du RGPD. Les utilisateurs sont responsables de leur propre conformité au RGPD lors de l'utilisation de cette librairie. Ils doivent s'assurer que leur utilisation de cette librairie est conforme aux exigences du RGPD et de toute autre législation applicable en matière de protection des données. +> - Eu égard l'ensemble de ces remarques, les contributeurs et *a fortiori* l'auteur du projet ne peuvent être tenus responsables de tout dommage potentiel. + +{{>main}} diff --git a/package.json b/package.json index c42a624..1d1d219 100644 --- a/package.json +++ b/package.json @@ -34,6 +34,11 @@ "Gazpar", "Gaz" ], + "scripts": { + "build": "tsc -p tsconfig.json", + "lint": "eslint src/ --ext .ts", + "doc": "jsdoc2md --template docs/README.hbs -f dist/index.js > README.md" + }, "description": "Unofficial API client of GRDF", "dependencies": { "@okta/okta-auth-js": "^7.5.1", diff --git a/src/index.ts b/src/index.ts index 9156a9a..54b894e 100644 --- a/src/index.ts +++ b/src/index.ts @@ -21,9 +21,6 @@ export { Frequency } export { ConsommationType } /** - * 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. * @example ```js * const { GRDF, ConsommationType } = require('grdf-api') * const pce = '01234567890123'