From e6e88486a8578c79c50b32502bc628652f99a5d1 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Sun, 7 Apr 2024 15:51:56 +0000 Subject: [PATCH] Auto-update READMEs --- ALL_README.md | 6 ++++++ README.md | 13 ++++++------ README_eu.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++ README_fr.md | 29 +++++++++++++------------- README_gl.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 142 insertions(+), 20 deletions(-) create mode 100644 ALL_README.md create mode 100644 README_eu.md create mode 100644 README_gl.md 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 c01f8fb..6aae958 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Install 2FAuth with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=2fauth) -*[Lire ce readme en français.](./README_fr.md)* +*[Read this README in other languages.](./ALL_README.md)* -> *This package allows you to install 2FAuth 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 2FAuth 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 @@ -26,6 +26,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in - Add custom account without QR code thanks to an advanced form - Edit accounts, even the imported ones - Generate TOTP and HOTP security codes + **Shipped version:** 5.1.0~ynh1 **Demo:** @@ -43,9 +44,9 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing). +Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/2fauth_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/2fauth_ynh/tree/testing --debug diff --git a/README_eu.md b/README_eu.md new file mode 100644 index 0000000..4967b2c --- /dev/null +++ b/README_eu.md @@ -0,0 +1,57 @@ + + +# 2FAuth YunoHost-erako + +[![Integrazio maila](https://dash.yunohost.org/integration/2fauth.svg)](https://dash.yunohost.org/appci/app/2fauth) ![Funtzionamendu egoera](https://ci-apps.yunohost.org/ci/badges/2fauth.status.svg) ![Mantentze egoera](https://ci-apps.yunohost.org/ci/badges/2fauth.maintain.svg) + +[![Instalatu 2FAuth YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=2fauth) + +*[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)* + +> *Pakete honek 2FAuth YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.* +> *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.* + +## Aurreikuspena + +2FAuth is a web based self-hosted alternative to One Time Passcode (OTP) generators like Google Authenticator, designed for both mobile and desktop. +2FAuth aims to ease you perform your 2FA authentication steps whatever the device you handle, with a clean and suitable interface. + +### Features + +- Manage your 2FA accounts and organize them using Groups +- Scan and decode any QR code to add account in no time +- Add custom account without QR code thanks to an advanced form +- Edit accounts, even the imported ones +- Generate TOTP and HOTP security codes + +**Paketatutako bertsioa:** 5.1.0~ynh1 + +**Demoa:** + +## Pantaila-argazkiak + +![2FAuth(r)en pantaila-argazkia](./doc/screenshots/screenshot.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/2fauth_ynh/tree/testing). + +`testing` abarra probatzeko, ondorengoa egin: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing --debug +edo +sudo yunohost app upgrade 2fauth -u https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing --debug +``` + +**Informazio gehiago aplikazioaren paketatzeari buruz:** diff --git a/README_fr.md b/README_fr.md index 5567787..4a47b1f 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ # 2FAuth pour YunoHost @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Installer 2FAuth avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=2fauth) -*[Read this readme in english.](./README.md)* +*[Lire le README dans d'autres langues.](./ALL_README.md)* -> *Ce package vous permet d’installer 2FAuth 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 2FAuth 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 @@ -26,9 +26,10 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po - Ajoutez un compte personnalisé sans QR code grâce à un formulaire avancé - Modifier les comptes, même ceux importés - Générer des codes de sécurité TOTP et HOTP -**Version incluse :** 5.1.0~ynh1 -**Démo :** +**Version incluse :** 5.1.0~ynh1 + +**Démo :** ## Captures d’écran @@ -36,16 +37,16 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po ## 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/2fauth_ynh/tree/testing). +Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/2fauth_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/2fauth_ynh/tree/testing --debug @@ -53,4 +54,4 @@ ou sudo yunohost app upgrade 2fauth -u https://github.com/YunoHost-Apps/2fauth_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..cf46cf8 --- /dev/null +++ b/README_gl.md @@ -0,0 +1,57 @@ + + +# 2FAuth para YunoHost + +[![Nivel de integración](https://dash.yunohost.org/integration/2fauth.svg)](https://dash.yunohost.org/appci/app/2fauth) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/2fauth.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/2fauth.maintain.svg) + +[![Instalar 2FAuth con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=2fauth) + +*[Le este README en outros idiomas.](./ALL_README.md)* + +> *Este paquete permíteche instalar 2FAuth 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 + +2FAuth is a web based self-hosted alternative to One Time Passcode (OTP) generators like Google Authenticator, designed for both mobile and desktop. +2FAuth aims to ease you perform your 2FA authentication steps whatever the device you handle, with a clean and suitable interface. + +### Features + +- Manage your 2FA accounts and organize them using Groups +- Scan and decode any QR code to add account in no time +- Add custom account without QR code thanks to an advanced form +- Edit accounts, even the imported ones +- Generate TOTP and HOTP security codes + +**Versión proporcionada:** 5.1.0~ynh1 + +**Demo:** + +## Capturas de pantalla + +![Captura de pantalla de 2FAuth](./doc/screenshots/screenshot.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/2fauth_ynh/tree/testing). + +Para probar a rama `testing`, procede deste xeito: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing --debug +ou +sudo yunohost app upgrade 2fauth -u https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing --debug +``` + +**Máis info sobre o empaquetado da app:**