From 16bb5dbbede74ef0d4ec951fe58ad7ae15ccb726 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Fri, 25 Mar 2022 17:30:47 +0000 Subject: [PATCH] Auto-update README --- README.md | 61 +++++++++++++++++++++------------------------------- README_fr.md | 53 +++++++++++++++++++++++---------------------- 2 files changed, 51 insertions(+), 63 deletions(-) diff --git a/README.md b/README.md index 820e437..fbb97a3 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,39 @@ - -# Packaging an app, starting from this example - -- Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo. -- Edit the `manifest.json` with app specific info. -- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`. - - Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers) -- Add a `LICENSE` file for the package. -- Edit `doc/DISCLAIMER*.md` -- The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator - - ---- - -# Example app for YunoHost +# 2FAuth for YunoHost -[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) -[![Install example with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) +[![Integration level](https://dash.yunohost.org/integration/2fauth.svg)](https://dash.yunohost.org/appci/app/2fauth) ![](https://ci-apps.yunohost.org/ci/badges/2fauth.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/2fauth.maintain.svg) +[![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)* -> *This package allows you to install example quickly and simply on a YunoHost server. +> *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 -Explain in *a few (10~15) words* the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps) +2FAuth is a web based self-hosted alternative to One Time Passcode (OTP) generators like Google Authenticator, designed for both mobile and desktop. -**Shipped version:** 1.0~ynh1 +It aims to ease you perform your 2FA authentication steps whatever the device you handle, with a clean and suitable interface. -**Demo:** https://demo.example.com +### 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 + +**Shipped version:** 2.1.0~ynh1 + +**Demo:** https://demo.2fauth.app/login ## Screenshots - - ![](./doc/screenshots/example.jpg) - - - +![](./doc/screenshots/screenshot.png) ## Disclaimers / important information @@ -59,26 +50,22 @@ Explain in *a few (10~15) words* the purpose of the app or what it actually does * upgrade process / specificities / things to be aware of ? * security considerations ? - - ## Documentation and resources * Official app website: https://example.com -* Official user documentation: https://yunohost.org/apps -* Official admin documentation: https://yunohost.org/packaging_apps -* Upstream app code repository: https://some.forge.com/example/example -* YunoHost documentation for this app: https://yunohost.org/app_example -* Report a bug: https://github.com/YunoHost-Apps/example_ynh/issues +* Upstream app code repository: https://github.com/Bubka/2FAuth +* YunoHost documentation for this app: https://yunohost.org/app_2fauth +* Report a bug: https://github.com/YunoHost-Apps/2fauth_ynh/issues ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_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. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing --debug or -sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug +sudo yunohost app upgrade 2fauth -u https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing --debug ``` -**More info regarding app packaging:** https://yunohost.org/packaging_apps +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index d856bf9..d076b2b 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,30 +1,35 @@ -# Example app pour YunoHost +# 2FAuth pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) -[![Installer example avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) +[![Niveau d'intégration](https://dash.yunohost.org/integration/2fauth.svg)](https://dash.yunohost.org/appci/app/2fauth) ![](https://ci-apps.yunohost.org/ci/badges/2fauth.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/2fauth.maintain.svg) +[![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 ce readme en français.](./README_fr.md)* -> *This package allows you to install example 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.* +> *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.* ## Vue d'ensemble -Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'objectif est de donner une idée grossière pour des utilisateurs qui naviguent dans un catalogue de 100+ apps) +2FAuth is a web based self-hosted alternative to One Time Passcode (OTP) generators like Google Authenticator, designed for both mobile and desktop. -**Version incluse:** 1.0~ynh1 +It aims to ease you perform your 2FA authentication steps whatever the device you handle, with a clean and suitable interface. -**Démo:** https://demo.example.com +### 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 + +**Version incluse :** 2.1.0~ynh1 + +**Démo :** https://demo.2fauth.app/login ## Captures d'écran - - ![](./doc/screenshots/example.jpg) - - - +![](./doc/screenshots/screenshot.png) ## Avertissements / informations importantes @@ -41,26 +46,22 @@ Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'o * upgrade process / specificities / things to be aware of ? * security considerations ? - - ## Documentations et ressources -* Site official de l'app : https://example.com -* Documentation officielle utilisateur: https://yunohost.org/apps -* Documentation officielle de l'admin: https://yunohost.org/packaging_apps -* Dépôt de code officiel de l'app: https://some.forge.com/example/example -* Documentation YunoHost pour cette app: https://yunohost.org/app_example -* Signaler un bug: https://github.com/YunoHost-Apps/example_ynh/issues +* Site officiel de l'app : https://example.com +* Dépôt de code officiel de l'app : https://github.com/Bubka/2FAuth +* Documentation YunoHost pour cette app : https://yunohost.org/app_2fauth +* Signaler un bug : https://github.com/YunoHost-Apps/2fauth_ynh/issues ## Informations pour les développeurs -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_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. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug -or -sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug +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 ``` -**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps \ No newline at end of file +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file