YunoHost-Apps/zwave-js-ui_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/zwave-js-ui_ynh.git synced 2024-09-03 18:06:00 +02:00
Code Issues Activity Actions

Update documentation

Browse source
This commit is contained in:
Krakinou 2022-11-19 18:04:30 +01:00
parent 2ea2a15208
commit 2deb41ce33
4 changed files with 14 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/DESCRIPTION.md
View file

@ -2,4 +2,9 @@
### Features
Integrate zwave-js-ui natively in Domoticz_ynh
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.
This app may also be usable with [Home-Assistant package](https://github.com/YunoHost-Apps/homeassistant_ynh) but I never tested it.

7
doc/DESCRIPTION_fr.md
View file

@ -3,4 +3,9 @@
### Fonctionnalités
Intègre zwave-js-ui dans domoticz_ynh de façon native
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.
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.

12
doc/DISCLAIMER.md
View file

@ -2,15 +2,5 @@
*** !! WORK IN PROGRESS !! - DO NOT INSTALL YET ***
* Any known limitations, constrains or stuff not working, such as (but not limited to):
* requiring a full dedicated domain => Due to the fact that is is compiled with the path and I don't want to recompile it each time
* architectures not supported ?
* not-working single-sign on or LDAP integration ?
* the app requires an important amount of RAM / disk / .. to install or to work properly
* etc...
For now, although the package is fully functional (install, remove, backup, restore...), it is not yet integrated with domoticz and mosquitto package, this means that all settings needs to be done manually from inside the app.
* Other infos that people should be aware of, such as:
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
* how to configure / administrate the application if it ain't obvious
* upgrade process / specificities / things to be aware of ?
* security considerations ?

13
doc/DISCLAIMER_fr.md
View file

@ -2,15 +2,4 @@
*** !! EN COURS DE CONSTRUCTION !! - NE PAS INSTALLER ***
* Any known limitations, constrains or stuff not working, such as (but not limited to):
* requiring a full dedicated domain ?
* architectures not supported ?
* not-working single-sign on or LDAP integration ?
* the app requires an important amount of RAM / disk / .. to install or to work properly
* etc...
* Other infos that people should be aware of, such as:
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
* how to configure / administrate the application if it ain't obvious
* upgrade process / specificities / things to be aware of ?
* security considerations ?
Pour l'instant, bien que le package fonctionne (installation, désinstallation, sauvegarde, restauration...), il n'est pas encore intégré avec domoticz et mosquitto, les paramétrages doivent être fait manuellement depuis l'application.