diff --git a/README.md b/README.md index b25b56912533e54d1338a32e278e0107c0112791..8815278c5a9504a6982dca5867cd261d3a24b3ef 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,13 @@ Ecolyo is a mobile-first app allowing citizens to visualise easily their energy consumption (electricity, gas, water ...). The app allows data visualisation but give also some tips on how to reduce energy consumption. +## Ecolyo au-delà de la Métropole de Lyon + +<https://doc-self-data.apps.grandlyon.com/docs/ecolyo/share/> + ## How does it works ? -Ecolyo uses "konnectors" for fetching data. More on : +Ecolyo uses "konnectors" for fetching data. More information on our [konnector documentation](https://doc-self-data.apps.grandlyon.com/docs/konnectors/introduction/). Repositories for our konnectors : - [enedis konnector](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/enedis-sge-konnector) - [grdf konnector](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/grdf-konnector) @@ -14,21 +18,11 @@ Ecolyo uses "konnectors" for fetching data. More on : ## Development -For a more complete look at our project, check our [Self Data Docs](https://doc-self-data.apps.grandlyon.com/) +For a more complete look at our project and our installation guide, check our **[Self Data Docs](https://doc-self-data.apps.grandlyon.com/)** _:pushpin: Note:_ we recommend to use [Yarn] instead of NPM for package management. -Developing the Cozy Ecolyo app requires you to be familiar with [cozy's documentation](https://docs.cozy.io/en/). - -You can then clone the app repository and install dependencies: - -```sh -git clone https://forge.grandlyon.com/web-et-numerique/factory/llle_project/ecolyo.git -cd ecolyo -yarn -``` - -Cozy's apps use a standard set of _npm scripts_ to run common tasks, like watch, lint, test, build… +Developing the Cozy Ecolyo app requires you to be familiar with [cozy's documentation](https://docs.cozy.io/en/). Cozy's apps use a standard set of _scripts_ to run common tasks, like watch, lint, test, build… ### Run it inside a default Cozy using Docker