diff --git a/README.md b/README.md index 54bfc93..b70c7a9 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,53 @@ + + # Jeedom for YunoHost -[![Integration level](https://dash.yunohost.org/integration/jeedom.svg)](https://dash.yunohost.org/appci/app/jeedom) ![](https://ci-apps.yunohost.org/ci/badges/jeedom.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/jeedom.maintain.svg) -[![Install Jeedom with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=jeedom) +[![Integration level](https://dash.yunohost.org/integration/jeedom.svg)](https://dash.yunohost.org/appci/app/jeedom) ![Working status](https://ci-apps.yunohost.org/ci/badges/jeedom.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/jeedom.maintain.svg) +[![Install Jeedom with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=jeedom) -> *This package allows you to install Jeedom quickly and simply on a YunoHost server. +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install Jeedom 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 + Jeedom is an home automation software. -**Shipped version:** 4.1.19 + +**Shipped version:** 4.1.19~ynh1 ## Screenshots -![Jeedom](https://www.jeedom.com/site/img/01-Appli-jeedom.png) +![Screenshot of Jeedom](./doc/screenshots/01-Appli-jeedom.png) -## YunoHost specific features +## Disclaimers / important information #### Multi-user support - LDAP login: your YunoHost users also become Jeedom users -#### Supported architectures +## Documentation and resources -* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/jeedom%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/jeedom/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/jeedom%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/jeedom/) +* Official app website: +* Official admin documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: -## Links - - * Report a bug: https://github.com/YunoHost-Apps/jeedom_ynh/issues - * App website: https://www.jeedom.com/ - * Upstream app repository: https://github.com/jeedom/core - * YunoHost website: https://yunohost.org/ - ---- - -Developer info ----------------- +## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/jeedom_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/jeedom_ynh/tree/testing --debug or sudo yunohost app upgrade jeedom -u https://github.com/YunoHost-Apps/jeedom_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..ceeead4 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,53 @@ + + +# Jeedom pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/jeedom.svg)](https://dash.yunohost.org/appci/app/jeedom) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/jeedom.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/jeedom.maintain.svg) +[![Installer Jeedom avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=jeedom) + +*[Read this readme in english.](./README.md)* + +> *Ce package vous permet d'installer Jeedom 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 + +Jeedom is an home automation software. + + +**Version incluse :** 4.1.19~ynh1 + +## Captures d'écran + +![Capture d'écran de Jeedom](./doc/screenshots/01-Appli-jeedom.png) + +## Avertissements / informations importantes + +#### Multi-user support + +- LDAP login: your YunoHost users also become Jeedom users + +## Documentations et ressources + +* Site officiel de l'app : +* Documentation officielle de l'admin : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/jeedom_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. + +``` bash +sudo yunohost app install https://github.com/YunoHost-Apps/jeedom_ynh/tree/testing --debug +ou +sudo yunohost app upgrade jeedom -u https://github.com/YunoHost-Apps/jeedom_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :**