Skip to content

Commit

Permalink
docs: add disclaimer
Browse files Browse the repository at this point in the history
  • Loading branch information
maelgangloff committed Apr 23, 2024
1 parent 8735bb4 commit 4437379
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 7 deletions.
25 changes: 21 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
<a name="GRDF"></a>

## 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)
Expand Down
22 changes: 22 additions & 0 deletions docs/README.hbs
Original file line number Diff line number Diff line change
@@ -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}}
5 changes: 5 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
3 changes: 0 additions & 3 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down

0 comments on commit 4437379

Please sign in to comment.