diff --git a/README.md b/README.md index be8b25f..2981112 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,34 @@ + + # Facette for YunoHost [![Integration level](https://dash.yunohost.org/integration/facette.svg)](https://dash.yunohost.org/appci/app/facette) ![](https://ci-apps.yunohost.org/ci/badges/facette.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/facette.maintain.svg) -[![Install Facette with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=facette) +[![Install Facette with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=facette) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install Facette quickly and simply on a YunoHost server. +> *This package allows you to install Facette quickly and simply on a YunoHost server. If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* ## Overview -Facette is a web application to display time series data from various sources — such as collectd, Graphite, InfluxDB or KairosDB — on graphs, designed to be easy to setup and to use. -**Shipped version:** 0.37.0 +Time series data visualization software -## Screenshots +**Shipped version:** 0.5.1~ynh1 -![](https://facette.io/assets/images/sshot-view1.png) +**Demo:** https://demo.example.com -## Demo +## Documentation and resources -* [Official demo](https://play.facette.io/browse/) - -## Configuration - -## Documentation - - * Official documentation: - * YunoHost documentation: https://yunohost.org/#/app_facette - -## YunoHost specific features - -#### Multi-user support - -* Is LDAP supported? **No** -* Can the app be used by multiple users? **Yes** - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/facette%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/facette/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/facette%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/facette/) - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/facette_ynh/issues - * App website: https://facette.io/ - * Upstream app repository: https://github.com/facette/facette - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: https://facette.io/ +* Official user documentation: https://yunohost.org/apps +* Official admin documentation: https://docs.facette.io/ +* Upstream app code repository: https://github.com/facette/facette +* YunoHost documentation for this app: https://yunohost.org/app_facette +* Report a bug: https://github.com/YunoHost-Apps/facette_ynh/issues ## Developer info @@ -59,3 +40,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/facette_ynh/tree/test or sudo yunohost app upgrade facette -u https://github.com/YunoHost-Apps/facette_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..3aa3049 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,40 @@ +# Facette pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/facette.svg)](https://dash.yunohost.org/appci/app/facette) ![](https://ci-apps.yunohost.org/ci/badges/facette.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/facette.maintain.svg) +[![Installer Facette avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=facette) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Facette rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* + +## Vue d'ensemble + +Logiciel de visualisation de données de séries chronologiques + +**Version incluse :** 0.5.1~ynh1 + +**Démo :** https://demo.example.com + +## Documentations et ressources + +* Site officiel de l'app : https://facette.io/ +* Documentation officielle utilisateur : https://yunohost.org/apps +* Documentation officielle de l'admin : https://docs.facette.io/ +* Dépôt de code officiel de l'app : https://github.com/facette/facette +* Documentation YunoHost pour cette app : https://yunohost.org/app_facette +* Signaler un bug : https://github.com/YunoHost-Apps/facette_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/facette_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/facette_ynh/tree/testing --debug +ou +sudo yunohost app upgrade facette -u https://github.com/YunoHost-Apps/facette_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file