diff --git a/ALL_README.md b/ALL_README.md new file mode 100644 index 0000000..77b7509 --- /dev/null +++ b/ALL_README.md @@ -0,0 +1,6 @@ +# All available README files by language + +- [Read the README in English](README.md) +- [Irakurri README euskaraz](README_eu.md) +- [Lire le README en français](README_fr.md) +- [Le o README en galego](README_gl.md) diff --git a/README.md b/README.md index 213a6f5..b54e90c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Install Scrutiny with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=scrutiny) -*[Lire ce readme en français.](./README_fr.md)* +*[Read this README in other languages.](./ALL_README.md)* -> *This package allows you to install Scrutiny 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 Scrutiny 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 @@ -34,7 +34,8 @@ Scrutiny is a simple but focused application, with a couple of core features: - Configurable Alerting/Notifications via Webhooks - (Future) Hard Drive performance testing & tracking -**Shipped version:** 0.8.0~ynh1 + +**Shipped version:** 0.8.1~ynh1 ## Screenshots @@ -49,9 +50,9 @@ Scrutiny is a simple but focused application, with a couple of core features: ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/scrutiny_ynh/tree/testing). +Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/scrutiny_ynh/tree/testing). -To try the testing branch, please proceed like that. +To try the `testing` branch, please proceed like that: ```bash sudo yunohost app install https://github.com/YunoHost-Apps/scrutiny_ynh/tree/testing --debug diff --git a/README_eu.md b/README_eu.md new file mode 100644 index 0000000..562726f --- /dev/null +++ b/README_eu.md @@ -0,0 +1,63 @@ + + +# Scrutiny YunoHost-erako + +[![Integrazio maila](https://dash.yunohost.org/integration/scrutiny.svg)](https://dash.yunohost.org/appci/app/scrutiny) ![Funtzionamendu egoera](https://ci-apps.yunohost.org/ci/badges/scrutiny.status.svg) ![Mantentze egoera](https://ci-apps.yunohost.org/ci/badges/scrutiny.maintain.svg) + +[![Instalatu Scrutiny YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=scrutiny) + +*[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)* + +> *Pakete honek Scrutiny YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.* +> *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.* + +## Aurreikuspena + +**Scrutiny is a Hard Drive Health Dashboard & Monitoring solution, merging manufacturer provided S.M.A.R.T metrics with real-world failure rates.** + +> NOTE: Scrutiny is a Work-in-Progress and still has some rough edges. + +### Features + +Scrutiny is a simple but focused application, with a couple of core features: + +- Web UI Dashboard - focused on Critical metrics +- `smartd` integration (no re-inventing the wheel) +- Auto-detection of all connected hard-drives +- S.M.A.R.T metric tracking for historical trends +- Customized thresholds using real world failure rates +- Temperature tracking +- Provided as an all-in-one Docker image (but can be installed manually) +- Configurable Alerting/Notifications via Webhooks +- (Future) Hard Drive performance testing & tracking + + +**Paketatutako bertsioa:** 0.8.1~ynh1 + +## Pantaila-argazkiak + +![Scrutiny(r)en pantaila-argazkia](./doc/screenshots/dashboard.png) + +## Dokumentazioa eta baliabideak + +- Administratzaileen dokumentazio ofiziala: +- Jatorrizko aplikazioaren kode-gordailua: +- YunoHost Denda: +- Eman errore baten berri: + +## Garatzaileentzako informazioa + +Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/scrutiny_ynh/tree/testing). + +`testing` abarra probatzeko, ondorengoa egin: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/scrutiny_ynh/tree/testing --debug +edo +sudo yunohost app upgrade scrutiny -u https://github.com/YunoHost-Apps/scrutiny_ynh/tree/testing --debug +``` + +**Informazio gehiago aplikazioaren paketatzeari buruz:** diff --git a/README_fr.md b/README_fr.md index 5459285..26231cc 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ # Scrutiny pour YunoHost @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Installer Scrutiny avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=scrutiny) -*[Read this readme in english.](./README.md)* +*[Lire le README dans d'autres langues.](./ALL_README.md)* -> *Ce package vous permet d’installer Scrutiny 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 Scrutiny 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 @@ -34,7 +34,8 @@ Scrutiny is a simple but focused application, with a couple of core features: - Configurable Alerting/Notifications via Webhooks - (Future) Hard Drive performance testing & tracking -**Version incluse :** 0.8.0~ynh1 + +**Version incluse :** 0.8.1~ynh1 ## Captures d’écran @@ -42,16 +43,16 @@ Scrutiny is a simple but focused application, with a couple of core features: ## Documentations et ressources -- Documentation officielle de l’admin : -- Dépôt de code officiel de l’app : -- YunoHost Store : -- Signaler un bug : +- Documentation officielle de l’admin : +- 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/scrutiny_ynh/tree/testing). +Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/scrutiny_ynh/tree/testing). -Pour essayer la branche testing, procédez comme suit. +Pour essayer la branche `testing`, procédez comme suit : ```bash sudo yunohost app install https://github.com/YunoHost-Apps/scrutiny_ynh/tree/testing --debug @@ -59,4 +60,4 @@ ou sudo yunohost app upgrade scrutiny -u https://github.com/YunoHost-Apps/scrutiny_ynh/tree/testing --debug ``` -**Plus d’infos sur le packaging d’applications :** +**Plus d’infos sur le packaging d’applications :** diff --git a/README_gl.md b/README_gl.md new file mode 100644 index 0000000..71e9cf8 --- /dev/null +++ b/README_gl.md @@ -0,0 +1,63 @@ + + +# Scrutiny para YunoHost + +[![Nivel de integración](https://dash.yunohost.org/integration/scrutiny.svg)](https://dash.yunohost.org/appci/app/scrutiny) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/scrutiny.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/scrutiny.maintain.svg) + +[![Instalar Scrutiny con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=scrutiny) + +*[Le este README en outros idiomas.](./ALL_README.md)* + +> *Este paquete permíteche instalar Scrutiny 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 + +**Scrutiny is a Hard Drive Health Dashboard & Monitoring solution, merging manufacturer provided S.M.A.R.T metrics with real-world failure rates.** + +> NOTE: Scrutiny is a Work-in-Progress and still has some rough edges. + +### Features + +Scrutiny is a simple but focused application, with a couple of core features: + +- Web UI Dashboard - focused on Critical metrics +- `smartd` integration (no re-inventing the wheel) +- Auto-detection of all connected hard-drives +- S.M.A.R.T metric tracking for historical trends +- Customized thresholds using real world failure rates +- Temperature tracking +- Provided as an all-in-one Docker image (but can be installed manually) +- Configurable Alerting/Notifications via Webhooks +- (Future) Hard Drive performance testing & tracking + + +**Versión proporcionada:** 0.8.1~ynh1 + +## Capturas de pantalla + +![Captura de pantalla de Scrutiny](./doc/screenshots/dashboard.png) + +## Documentación e recursos + +- Documentación oficial para admin: +- 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/scrutiny_ynh/tree/testing). + +Para probar a rama `testing`, procede deste xeito: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/scrutiny_ynh/tree/testing --debug +ou +sudo yunohost app upgrade scrutiny -u https://github.com/YunoHost-Apps/scrutiny_ynh/tree/testing --debug +``` + +**Máis info sobre o empaquetado da app:**