diff --git a/ALL_README.md b/ALL_README.md new file mode 100644 index 0000000..3d6c579 --- /dev/null +++ b/ALL_README.md @@ -0,0 +1,6 @@ +# All available README files by language + +- [Read the README in English](README.md) +- [Lire le README en français](README_fr.md) +- [Le o README en galego](README_gl.md) +- [Leggi il “README” in italiano](README_it.md) diff --git a/README.md b/README.md index 72aa001..5d0dbc1 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Install Node-RED with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=nodered) -*[Lire ce readme en français.](./README_fr.md)* +*[Read this README is other languages.](./ALL_README.md)* -> *This package allows you to install Node-RED 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.* +> *This package allows you to install Node-RED 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 @@ -47,7 +47,7 @@ logging: { // replace the default logging option ...defaultSettings.logging, // You can check the default settings Yunohost generates at `__INSTALL_DIR__/data/settings.js` and find the documentation for configuring Node-RED here: -**Shipped version:** 3.1.6~ynh1 +**Shipped version:** 3.1.8~ynh1 ## Screenshots @@ -55,22 +55,22 @@ You can check the default settings Yunohost generates at `__INSTALL_DIR__/data/s ## Documentation and resources -* Official app website: -* Official user documentation: -* Upstream app code repository: -* YunoHost Store: -* Report a bug: +- Official app website: +- Official user documentation: +- Upstream app code repository: +- YunoHost Store: +- Report a bug: ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/nodered_ynh/tree/testing). +Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/nodered_ynh/tree/testing). -To try the testing branch, please proceed like that. +To try the `testing` branch, please proceed like that: -``` bash +```bash sudo yunohost app install https://github.com/YunoHost-Apps/nodered_ynh/tree/testing --debug or sudo yunohost app upgrade nodered -u https://github.com/YunoHost-Apps/nodered_ynh/tree/testing --debug ``` -**More info regarding app packaging:** \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index 7f07ad6..239206b 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ # Node-RED pour YunoHost @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Installer Node-RED avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=nodered) -*[Read this readme in english.](./README.md)* +*[Lire le README dans d'autres langues.](./ALL_README.md)* -> *Ce package vous permet d’installer Node-RED 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.* +> *Ce package vous permet d’installer Node-RED rapidement et simplement sur un serveur YunoHost.* +> *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.* ## Vue d’ensemble @@ -49,7 +49,7 @@ module.exports = (defaultSettings) => ({ Vous pouvez consulter les paramètres par défaut générez par Yunohost dans `__INSTALL_DIR__/data/settings.js` et trouver la documentation pour configurer Node-RED ici: -**Version incluse :** 3.1.6~ynh1 +**Version incluse :** 3.1.8~ynh1 ## Captures d’écran @@ -57,22 +57,22 @@ Vous pouvez consulter les paramètres par défaut générez par Yunohost dans `_ ## Documentations et ressources -* Site officiel de l’app : -* Documentation officielle utilisateur : -* Dépôt de code officiel de l’app : -* YunoHost Store: -* Signaler un bug : +- Site officiel de l’app : +- Documentation officielle utilisateur : +- Dépôt de code officiel de l’app : +- YunoHost Store : +- Signaler un bug : ## Informations pour les développeurs -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/nodered_ynh/tree/testing). +Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/nodered_ynh/tree/testing). -Pour essayer la branche testing, procédez comme suit. +Pour essayer la branche `testing`, procédez comme suit : -``` bash +```bash sudo yunohost app install https://github.com/YunoHost-Apps/nodered_ynh/tree/testing --debug ou sudo yunohost app upgrade nodered -u https://github.com/YunoHost-Apps/nodered_ynh/tree/testing --debug ``` -**Plus d’infos sur le packaging d’applications :** \ No newline at end of file +**Plus d’infos sur le packaging d’applications :** diff --git a/README_gl.md b/README_gl.md new file mode 100644 index 0000000..49b6bbc --- /dev/null +++ b/README_gl.md @@ -0,0 +1,76 @@ + + +# Node-RED para YunoHost + +[![Nivel de integración](https://dash.yunohost.org/integration/nodered.svg)](https://dash.yunohost.org/appci/app/nodered) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/nodered.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/nodered.maintain.svg) + +[![Instalar Node-RED con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=nodered) + +*[Le este README en outros idiomas.](./ALL_README.md)* + +> *Este paquete permíteche instalar Node-RED de xeito rápido e doado nun servidor YunoHost.* +> *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.* + +## Vista xeral + +Node-RED is a programming tool for wiring together hardware devices, APIs and online services in new and interesting ways. + +It provides a browser-based editor that makes it easy to wire together flows using the wide range of nodes in the palette that can be deployed to its runtime in a single-click. + +### Features + +- Browser-based flow editing +- On-click deployment of the flows +- Over 225,000 modules available +- Custom JavaScript functions can be written + +### Override the default settings + +From the installation directory, go edit the `__INSTALL_DIR__/data/settings.user.js`. For example: + +```js +module.exports = (defaultSettings) => ({ + lang: "de", // define the language as "de" + exportGlobalContextKeys: true, // override the `exportGlobalContextKeys` value +logging: { // replace the default logging option ...defaultSettings.logging, // this will reinject the default settings in logging + console: { + ...defaultSettings.logging.level, // this will reinject the default settings in logging.console + level: "debug", // but here, we override the "info" level by "debug" + }, + }, +}); +``` + +You can check the default settings Yunohost generates at `__INSTALL_DIR__/data/settings.js` and find the documentation for configuring Node-RED here: + + +**Versión proporcionada:** 3.1.8~ynh1 + +## Capturas de pantalla + +![Captura de pantalla de Node-RED](./doc/screenshots/screenshot.jpg) + +## Documentación e recursos + +- Web oficial da app: +- Documentación oficial para usuarias: +- Repositorio de orixe do código: +- Tenda YunoHost: +- Informar dun problema: + +## Info de desenvolvemento + +Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/nodered_ynh/tree/testing). + +Para probar a rama `testing`, procede deste xeito: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/nodered_ynh/tree/testing --debug +ou +sudo yunohost app upgrade nodered -u https://github.com/YunoHost-Apps/nodered_ynh/tree/testing --debug +``` + +**Máis info sobre o empaquetado da app:** diff --git a/README_it.md b/README_it.md new file mode 100644 index 0000000..22a9cb2 --- /dev/null +++ b/README_it.md @@ -0,0 +1,76 @@ + + +# Node-RED per YunoHost + +[![Livello di integrazione](https://dash.yunohost.org/integration/nodered.svg)](https://dash.yunohost.org/appci/app/nodered) ![Stato di funzionamento](https://ci-apps.yunohost.org/ci/badges/nodered.status.svg) ![Stato di manutenzione](https://ci-apps.yunohost.org/ci/badges/nodered.maintain.svg) + +[![Installa Node-RED con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=nodered) + +*[Leggi questo README in altre lingue.](./ALL_README.md)* + +> *Questo pacchetto ti permette di installare Node-RED su un server YunoHost in modo semplice e veloce.* +> *Se non hai YunoHost, consulta [la guida](https://yunohost.org/install) per imparare a installarlo.* + +## Panoramica + +Node-RED is a programming tool for wiring together hardware devices, APIs and online services in new and interesting ways. + +It provides a browser-based editor that makes it easy to wire together flows using the wide range of nodes in the palette that can be deployed to its runtime in a single-click. + +### Features + +- Browser-based flow editing +- On-click deployment of the flows +- Over 225,000 modules available +- Custom JavaScript functions can be written + +### Override the default settings + +From the installation directory, go edit the `__INSTALL_DIR__/data/settings.user.js`. For example: + +```js +module.exports = (defaultSettings) => ({ + lang: "de", // define the language as "de" + exportGlobalContextKeys: true, // override the `exportGlobalContextKeys` value +logging: { // replace the default logging option ...defaultSettings.logging, // this will reinject the default settings in logging + console: { + ...defaultSettings.logging.level, // this will reinject the default settings in logging.console + level: "debug", // but here, we override the "info" level by "debug" + }, + }, +}); +``` + +You can check the default settings Yunohost generates at `__INSTALL_DIR__/data/settings.js` and find the documentation for configuring Node-RED here: + + +**Versione pubblicata:** 3.1.8~ynh1 + +## Screenshot + +![Screenshot di Node-RED](./doc/screenshots/screenshot.jpg) + +## Documentazione e risorse + +- Sito web ufficiale dell’app: +- Documentazione ufficiale per gli utenti: +- Repository upstream del codice dell’app: +- Store di YunoHost: +- Segnala un problema: + +## Informazioni per sviluppatori + +Si prega di inviare la tua pull request alla [branch di `testing`](https://github.com/YunoHost-Apps/nodered_ynh/tree/testing). + +Per provare la branch di `testing`, si prega di procedere in questo modo: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/nodered_ynh/tree/testing --debug +o +sudo yunohost app upgrade nodered -u https://github.com/YunoHost-Apps/nodered_ynh/tree/testing --debug +``` + +**Maggiori informazioni riguardo il pacchetto di quest’app:**