diff --git a/source/README.md b/source/README.md index 36cd1d526c703cdf4ab05c066d86e8b0dcbd7577..fc4b79402824d7d5b744011eb56dc21ff8ae97d8 100644 --- a/source/README.md +++ b/source/README.md @@ -11,8 +11,13 @@ What's Cozy? What is this konnector about ? ------------------------------ -This konnector retrieves your <SOME DATA> and <SOME OTHER DATA> from <SERVICE> -<YOUR DESCRIPTION HERE> +This konnector retrieves your consumption data from GRDF website + +### Particularity of GRDF connector + +Because of the peculiar structure of GRDF's website, there are more functions called than in a regular connector. +We need to get the `javax.faces.ViewState` value in the page before each requests (authentication and data fetching). This is what `getJavaxFacesAuth` and `getJavaxFacesData` functions are for. +Moreover, for a reason not yet known, the data fetching `getData` works only if another request is made before that, hence the existence of `preGetData`. ### Open a Pull-Request @@ -45,7 +50,7 @@ This connector uses [cozy-konnector-libs](https://github.com/cozy/cozy-konnector ### Maintainer -The lead maintainers for this konnector is <YOUR NAME> +The lead maintainers for this konnector is Métropole de Lyon. ### Get in touch @@ -62,7 +67,7 @@ You can reach the Cozy Community by: License ------- -<YOUR KONNECTOR NAME> is developed by <your name> and distributed under the [AGPL v3 license][agpl-3.0]. +grdf-scraping-connector is developed by Métropole de Lyon and distributed under the [AGPL v3 license][agpl-3.0]. [cozy]: https://cozy.io "Cozy Cloud" [agpl-3.0]: https://www.gnu.org/licenses/agpl-3.0.html