diff --git a/README.md b/README.md index da632b6..ce829ab 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# FreshRSS package for YunoHost +# FreshRSS for YunoHost -[![Integration level](https://dash.yunohost.org/integration/freshrss.svg)](https://dash.yunohost.org/appci/app/freshrss) +[![Integration level](https://dash.yunohost.org/integration/freshrss.svg)](https://dash.yunohost.org/appci/app/freshrss) ![](https://ci-apps.yunohost.org/ci/badges/freshrss.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/freshrss.maintain.svg) [![Install FreshRSS with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=freshrss) > *This package allow you to install FreshRSS quickly and simply on a YunoHost server. @@ -22,11 +22,11 @@ An efficient but powerful RSS aggregator with a nice and mobile-friendly design, ## Configuration -API (mini) How To : -* Into your user profile : Settings > profil +API (mini) How To: +* Into your user profile: Settings > profil * Setup an API password -* Check the API is working : https://exemple.tld/rss/api/greader.php -* Setup your client with : username : ynh user, password : the password you just setup, url https://exemple.tld/rss/api/greader.php +* Check the API is working: https://exemple.tld/rss/api/greader.php +* Setup your client with: username: ynh user, password: the password you just setup, url https://exemple.tld/rss/api/greader.php ## Documentation @@ -34,9 +34,8 @@ API (mini) How To : #### Supported architectures -* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/freshrss%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/freshrss/) +* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/freshrss%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/freshrss/) * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/freshrss%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/freshrss/) -* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/freshrss%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/freshrss/) ## Links @@ -47,10 +46,8 @@ API (mini) How To : --- -Developers info ----------------- +## Developers info -**Only if you want to use a testing branch for coding, instead of merging directly into master.** Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/freshrss_ynh/tree/testing). To try the testing branch, please proceed like that. @@ -58,4 +55,4 @@ To try the testing branch, please proceed like that. sudo yunohost app install https://github.com/YunoHost-Apps/freshrss_ynh/tree/testing --debug or sudo yunohost app upgrade freshrss -u https://github.com/YunoHost-Apps/freshrss_ynh/tree/testing --debug -``` \ No newline at end of file +```