doc/app_freshrss.md

# <img src="/images/freshrss_logo.svg" width="80px" alt="APPLICATION's FreshRSS"> FreshRSS

[![Install FreshRSS with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=freshrss) [![Integration level](https://dash.yunohost.org/integration/freshrss.svg)](https://dash.yunohost.org/appci/app/freshrss)

### Index

- [Configuration](#configuration)
- [Customer Applications](#customer-applications)
- [Useful links](#useful-links)

FreshRSS is an RSS aggregator and reader. It allows you to read and follow several news websites at a glance without the need to browse from one website to another.

FreshRSS has a lot of features including.

## Configuration

API (mini) How To
1. Into your user profile : `Settings > profil`
2. Setup an API password
3. Check the API is working : https://exemple.tld/rss/api/greader.php
4. Setup your client with :
    + username : ynh user
    + password : the password you just setup
    + url https://exemple.tld/rss/api/greader.php

## Customer applications

| Application name | Platform | Multi-account | Play Store | F-Droid | Play Store |
|------------------|----------|---------------|------------|---------|------------|
| Fresh RSS | Android  | ? |  | [f-droid.org - Fresh RSS](https://f-droid.org/fr/packages/fr.chenry.android.freshrss/) | X |

## Useful links

+ Website: [www.freshrss.org](https://www.freshrss.org/)
+ Official documentation: [freshrss.github.io - FreshRSS](https://freshrss.github.io/FreshRSS/)
+ Application software repository: [github.com - YunoHost-Apps/freshrss](https://github.com/YunoHost-Apps/freshrss_ynh)
+ Fix a bug or an improvement by creating a ticket (issue): [github.com - YunoHost-Apps/freshrss/issues](https://github.com/YunoHost-Apps/freshrss_ynh/issues)