From ac833d628a1138e977b1e106873c6dbc18120a20 Mon Sep 17 00:00:00 2001 From: Krakinou Date: Sat, 19 Nov 2022 18:08:09 +0100 Subject: [PATCH] Update documentation --- doc/DESCRIPTION.md | 7 ++++--- doc/DESCRIPTION_fr.md | 7 ++++--- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index d2db9e9..37c1d97 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -1,10 +1,11 @@ -*** !! WORK IN PROGRESS !! - DO NOT INSTALL YET *** +** !! WORK IN PROGRESS !! - DO NOT INSTALL YET ** ### Features Integrate zwave-js-ui natively in Domoticz_ynh. -Zwave-JS-UI,also known under previous name ZWaveJS2MQTT, is a replacement for Openzwave, and exposes Z-Wave devices to an MQTT broker in a fully configurable manner. -To work correctly, this app require domoticz with mqtt server mosquitto installed. Please refer to [domoticz package for Yunohost](https://github.com/YunoHost-Apps/domoticz_ynh) for more information about how to set up domoticz and Mosquitto. +**Zwave-JS-UI**,also known under previous name ZWaveJS2MQTT, is a replacement for Openzwave. It exposes Z-Wave devices to an MQTT broker in a fully configurable manner. + +To work correctly, this app require **domoticz** with **mqtt broker Mosquitto** installed. Please refer to [domoticz package for Yunohost](https://github.com/YunoHost-Apps/domoticz_ynh) for more information about how to set up domoticz and Mosquitto. This app may also be usable with [Home-Assistant package](https://github.com/YunoHost-Apps/homeassistant_ynh) but I never tested it. \ No newline at end of file diff --git a/doc/DESCRIPTION_fr.md b/doc/DESCRIPTION_fr.md index 74a5f89..bc77988 100644 --- a/doc/DESCRIPTION_fr.md +++ b/doc/DESCRIPTION_fr.md @@ -1,11 +1,12 @@ -*** !! EN COURS DE CONSTRUCTION !! - NE PAS INSTALLER *** +** !! EN COURS DE CONSTRUCTION !! - NE PAS INSTALLER ** ### Fonctionnalités Intègre zwave-js-ui dans domoticz_ynh de façon native. -Zwave-JS-UI, aussi connu sous le nom de ZWaveJS2MQTT, est un remplaçant pour Openzwave. Il permet d'exposer les terminaux Z-Wave à un broker MQTT de façon complètement configurable. -Pour fonctionner correctement, cette application nécessite d'avoir domoticz avec un serveur mosquitto d'également installés. Veuillez vous reporter au [paquet domoticz pour Yunohost](https://github.com/YunoHost-Apps/domoticz_ynh) afin d'obtenir plus d'information sur comment le faire. +**Zwave-JS-UI**, aussi connu sous le nom de ZWaveJS2MQTT, est un remplaçant pour Openzwave. Il permet d'exposer les terminaux Z-Wave à un broker MQTT de façon complètement configurable. + +Pour fonctionner correctement, cette application nécessite d'avoir **domoticz** avec le **broker MQTT mosquitto** d'également installés. Veuillez vous reporter au [paquet domoticz pour Yunohost](https://github.com/YunoHost-Apps/domoticz_ynh) afin d'obtenir plus d'information sur comment le faire. Cette application fonctionne également peut-être avec [le paquet Home-Assistant](https://github.com/YunoHost-Apps/homeassistant_ynh) mais je ne l'ai jamais testée. \ No newline at end of file