diff --git a/README.md b/README.md index 6549ac8..14eab7c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ + + # Tiny Tiny RSS for YunoHost [![Integration level](https://dash.yunohost.org/integration/ttrss.svg)](https://dash.yunohost.org/appci/app/ttrss) ![](https://ci-apps.yunohost.org/ci/badges/ttrss.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/ttrss.maintain.svg) @@ -5,55 +10,42 @@ *[Lire ce readme en français.](./README_fr.md)* -> *This package allow you to install Tiny Tiny RSS quickly and simply on a YunoHost server. -If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* +> *This package allows you to install Tiny Tiny RSS 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 Tiny Tiny RSS is a free and open source web-based news feed (RSS/Atom) reader and aggregator. -**Shipped version:** 2020.09.16 +## Features + +- feed aggregation / syndication, +- OPML import/export, +- multiple ways to share stuff: export RSS feeds, plugins for various social sites, sharing by URL, etc, +- sharing arbitrary content through tt-rss, +- Plugins and themes, +- podcasts, +- flexible article filtering + +**Shipped version:** 20211221~ynh1 + +**Demo:** https://demo.yunohost.org/ttrss/ ## Screenshots -![](https://tt-rss.org/images/ttrss/18.12/1812-shot1.png) +![](./doc/screenshots/screenshot.png) -## Demo +## Documentation and resources -* [YunoHost demo](https://demo.yunohost.org/ttrss/) +* Official app website: http://tt-rss.org +* Official admin documentation: https://git.tt-rss.org/git/tt-rss/wiki +* Upstream app code repository: https://git.tt-rss.org/git/tt-rss +* YunoHost documentation for this app: https://yunohost.org/app_ttrss +* Report a bug: https://github.com/YunoHost-Apps/ttrss_ynh/issues -## Configuration +## Developer info -## Documentation - - * Official documentation: https://git.tt-rss.org/git/tt-rss/wiki - * YunoHost documentation: https://yunohost.org/en/app_ttrss - -## YunoHost specific features - -#### Multi-users support - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/ttrss.svg)](https://ci-apps.yunohost.org/ci/apps/ttrss/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/ttrss.svg)](https://ci-apps-arm.yunohost.org/ci/apps/ttrss/) - -## Limitations - -## Additionnal informations - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/ttrss_ynh/issues - * Tiny Tiny RSS website: https://tt-rss.org/ - * Tiny Tiny RSS repository: https://git.tt-rss.org/git/tt-rss - * YunoHost website: https://yunohost.org/ - ---- - -## Developers infos - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/ttrss_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/ttrss_ynh/tree/testing). To try the testing branch, please proceed like that. ``` @@ -61,3 +53,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/ttrss_ynh/tree/testin or sudo yunohost app upgrade ttrss -u https://github.com/YunoHost-Apps/ttrss_ynh/tree/testing --debug ``` + +**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 5d77adc..e9f7f27 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,62 +1,38 @@ # Tiny Tiny RSS pour YunoHost -[![Integration level](https://dash.yunohost.org/integration/ttrss.svg)](https://dash.yunohost.org/appci/app/ttrss) ![](https://ci-apps.yunohost.org/ci/badges/ttrss.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/ttrss.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/ttrss.svg)](https://dash.yunohost.org/appci/app/ttrss) ![](https://ci-apps.yunohost.org/ci/badges/ttrss.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/ttrss.maintain.svg) [![Installer Tiny Tiny RSS avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ttrss) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d’installer Tiny Tiny RSS rapidement et simplement sur un serveur YunoHost. -Si vous n’avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l’installer.* +> *Ce package vous permet d'installer Tiny Tiny RSS 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 +## Vue d'ensemble Tiny Tiny RSS est un lecteur et agrégateur de flux d'actualités (RSS/Atom) en ligne gratuit et open source. -**Version incluse :** 2020.09.16 -## Captures d’écran +**Version incluse :** 20211221~ynh1 -![](https://tt-rss.org/images/ttrss/18.12/1812-shot1.png) +**Démo :** https://demo.yunohost.org/ttrss/ -## Démo +## Captures d'écran -* [YunoHost demo](https://demo.yunohost.org/ttrss/) +![](./doc/screenshots/screenshot.png) -## Configuration +## Documentations et ressources -## Documentation +* Site officiel de l'app : http://tt-rss.org +* Documentation officielle de l'admin : https://git.tt-rss.org/git/tt-rss/wiki +* Dépôt de code officiel de l'app : https://git.tt-rss.org/git/tt-rss +* Documentation YunoHost pour cette app : https://yunohost.org/app_ttrss +* Signaler un bug : https://github.com/YunoHost-Apps/ttrss_ynh/issues -* Documentation officielle : https://git.tt-rss.org/git/tt-rss/wiki -* Documentation YunoHost : https://yunohost.org/fr/app_ttrss +## Informations pour les développeurs -## Caractéristiques spécifiques YunoHost - -#### Support multi-utilisateurs - -* L’authentification LDAP est-elle prise en charge ? **Oui** -* L’application peut-elle être utilisée par plusieurs utilisateurs ? **Oui** - -#### Architectures supportées - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/ttrss.svg)](https://ci-apps.yunohost.org/ci/apps/ttrss/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/ttrss.svg)](https://ci-apps-arm.yunohost.org/ci/apps/ttrss/) - -## Limitations - -## Informations additionnelles - -## Liens - -* Signaler un bug : https://github.com/YunoHost-Apps/ttrss_ynh/issues -* Site web de Tiny Tiny RSS : https://tt-rss.org/ -* Dépôt de l’application principale : https://git.tt-rss.org/git/tt-rss -* Site web YunoHost : https://yunohost.org/ - ---- - -## Developers infos - -Merci de faire vos pull request sur la [testing branch](https://github.com/YunoHost-Apps/ttrss_ynh/tree/testing). +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/ttrss_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. ``` @@ -64,3 +40,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/ttrss_ynh/tree/testin ou sudo yunohost app upgrade ttrss -u https://github.com/YunoHost-Apps/ttrss_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file