diff --git a/README.md b/README.md index cea21f6..5972aaa 100644 --- a/README.md +++ b/README.md @@ -16,12 +16,12 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -[Wallabag](https://www.wallabag.org/) is a self hostable Read-It-Later application allowing you to not miss any content anymore. Click, save, read it when you can. -It extracts content so that you can read it when you have time. +Wallabag is a self hostable Read-It-Later application allowing you to not miss any content anymore. Click, save, read it when you can. +It provides a web interface, browser (Firefox/Chrome/Opera) add-ons, mobile apps (Android/iOS/Windows Phone) and even on e-reader (PocketBook/Kobo). -It provides a web interface, browser (Firefox / Chrome / Opera) add-ons, mobile apps (Android / iOS / Windows Phone) and even on e-reader (PocketBook / Kobo). +Upgrade from the YunoHost [Wallabag v1](https://github.com/YunoHost-Apps/wallabag_ynh) app requires a manual operation. That's why it's provided as a new package. For the migration process, please refer to the [Wallabag official documentation](https://doc.wallabag.org/en/user/import/wallabagv1.html). -**Shipped version:** 2.5.4~ynh2 +**Shipped version:** 2.5.4~ynh3 **Demo:** @@ -29,26 +29,6 @@ It provides a web interface, browser (Firefox / Chrome / Opera) add-ons, mobile ![Screenshot of Wallabag](./doc/screenshots/screenshot1.webp) -## Disclaimers / important information - -### YunoHost specific features -In addition to Wallabag core features, the following are made available with this package: - - * Integrate with YunoHost users and SSO - i.e. logout button - * Allow one user to be the administrator (set at the installation) - * Asynchronous import using *Redis* (need to be enabled in the *Internal Settings*). *RabbitMQ* import not supported (yet?). - -### Limitations - -* Removing a Yunohost's user won't delete the related wallabag user, but only desactivate it. You need to manualy remove it from wallabag before. See: https://github.com/YunoHost-Apps/wallabag2_ynh/issues/39 -* Upgrade from the YunoHost [Wallabag v1](https://github.com/YunoHost-Apps/wallabag_ynh) app requires a manual operation. That's why it's provided as a new package. For the migration process, please refer to the [Wallabag official documentation](https://doc.wallabag.org/en/user/import/wallabagv1.html). - -### (Beta) Testing branch -*Please be aware that the testing branch (or any PR branch)* might *contains some bugs and is not recommended if you need a stable app.* - -(Beta) Testers are welcome to try new upgrades (such as a new version), as listed in the [Pull Requests section](https://github.com/YunoHost-Apps/wallabag2_ynh/pulls). More testing will allow us to provide upgrades faster 🙂. In order to try the testing branch, use `sudo yunohost app upgrade wallabag2 -u https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing`. - -Warning : Doing a normal upgrade of the package with the web admin or `sudo yunohost app upgrade wallabag2` (without any URL specified) will revert you app to the master branch. *This may break you wallabag* if it goes to a previous version (if the newest is not retrocompatible). ## Documentation and resources - Official app website: diff --git a/README_fr.md b/README_fr.md index 7910a36..1ef87cb 100644 --- a/README_fr.md +++ b/README_fr.md @@ -16,11 +16,12 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po ## Vue d’ensemble -[Wallabag](https://www.wallabag.org/) est une application de lecture diffĂ©rĂ©e : elle permet simplement d’archiver une page web en ne conservant que le contenu. Les Ă©lĂ©ments superflus (menus, publicitĂ©s, etc.) sont supprimĂ©s. +Wallabag est une application de lecture diffĂ©rĂ©e : elle permet simplement d’archiver une page web en ne conservant que le contenu. Les Ă©lĂ©ments superflus (menus, publicitĂ©s, etc.) sont supprimĂ©s. +Sont disponibles une interface web, des add-ons pour navigateurs (Firefox/Chrome/Opera), des applications pour mobile (Android/iOS/Windows Phone) et mĂȘme sur liseuse (PocketBook/Kobo). -Sont disponibles une interface web, des add-ons pour navigateurs (Firefox / Chrome / Opera), des applications pour mobile (Android / iOS / Windows Phone) et mĂȘme sur liseuse (PocketBook / Kobo). +La mise Ă  niveau depuis le paquet YunoHost de [Wallabag v1](https://github.com/YunoHost-Apps/wallabag_ynh) demande une opĂ©ration manuelle, c'est pourquoi un nouveau paquet est fournit. Pour le processus de migration, merci de vous rĂ©fĂ©rer Ă  [la documentation officiel de Wallabag](https://doc.wallabag.org/fr/user/import/wallabagv1.html). -**Version incluse :** 2.5.4~ynh2 +**Version incluse :** 2.5.4~ynh3 **DĂ©mo :** @@ -28,31 +29,6 @@ Sont disponibles une interface web, des add-ons pour navigateurs (Firefox / Chro ![Capture d’écran de Wallabag](./doc/screenshots/screenshot1.webp) -## Avertissements / informations importantes - -### CaractĂ©ristiques spĂ©cifiques YunoHost - -En plus des fonctionnalitĂ©s principales de Wallabag, ce paquet propose Ă©galement : - - * Une intĂ©gration avec le systĂšme de gestion des utilisateurs et le SSO de YunoHost - e.g. un bouton de dĂ©connexion - * De permettre Ă  un utilisateur d'ĂȘtre administrateur (rĂ©glage lors de l'installation) - * Un import asynchrone utilisant Redis (À  activer dans les *ParamĂštres Internes*). L'import via RabbitMQ n'est pas (encore ?) supportĂ©. - -### Limitations - -* Supprimer un utilisateur YunoHost ne supprimera pas l'utilisateur Wallabag liĂ©, il sera seulement dĂ©sactivĂ©. Vous devez le supprimer manuellement avant. Voir : https://github.com/YunoHost-Apps/wallabag2_ynh/issues/39 - -* La mise à niveau depuis le paquet YunoHost de [Wallabag v1](https://github.com/YunoHost-Apps/wallabag_ynh) demande une opĂ©ration manuelle, c'est pourquoi un nouveau paquet est fournit. Pour le processus de migration, merci de vous référer à [la documentation officiel de Wallabag](https://doc.wallabag.org/fr/user/import/wallabagv1.html). - - -### Branche de test (*Testing*) -*Soyez concient que la branche testing* pourrait *contenir des bugs et n'est pas recommandĂ©e si vous recherchez la stabilitĂ© de votre application.* - -Les personnes souhaitant (bĂȘta) tester de nouvelles mises Ă  jour (ex: une nouvelle version), listée dans la [section des Pull Requests](https://github.com/YunoHost-Apps/wallabag2_ynh/pulls), sont les bienvenues. Plus de tests nous permettrons de sortir des mises Ă  jour plus vite. Pour tester la branche *testing*, utilisez `sudo yunohost app upgrade wallabag2 -u https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing`. - -Attention : Une mise Ă  jour classique avec l'interface d'administration ou avec `sudo yunohost app upgrade wallabag2` (sans prĂ©ciser l'URL) fera retourner votre application au niveau de la branche master. *Ceci pourrait casser votre wallabag* si vous revenez Ă  une version prĂ©cĂ©dente (et si la nouvelle n'est pas rĂ©trocompatible). - - ## Documentations et ressources - Site officiel de l’app :