freshrss_ynh/README.md

<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->

# FreshRSS for YunoHost

[![Integration level](https://dash.yunohost.org/integration/freshrss.svg)](https://dash.yunohost.org/appci/app/freshrss) ![Working status](https://ci-apps.yunohost.org/ci/badges/freshrss.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/freshrss.maintain.svg)  
[![Install FreshRSS with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=freshrss)

*[Lire ce readme en français.](./README_fr.md)*

> *This package allows you to install FreshRSS 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

An efficient but powerful RSS aggregator with a nice and mobile-friendly design, as well as extension and themes support.


**Shipped version:** 1.20.0~ynh1 *(:warning: This is the `upgrade` branch. The [`master` branch](https://github.com/YunoHost-Apps/freshrss_ynh/tree/master) used in the catalog is currently on version 1.19.2\~ynh1.)*


**Demo:** https://demo.freshrss.org

## Screenshots

![Screenshot of FreshRSS](./doc/screenshots/screenshot.png)

## Disclaimers / important information

## Configuration

API (mini) How To:
* Into your user profile: Settings > profil
* Setup an API password
* Check that the API is working: https://example.net/rss/api/greader.php
* Setup your client with: username: ynh user, password: the password you just setup, URL https://example.tld/rss/api/greader.php

## Documentation and resources

* Official app website: <http://freshrss.org/>
* Official admin documentation: <https://freshrss.github.io/FreshRSS/>
* Upstream app code repository: <https://github.com/FreshRSS/FreshRSS>
* YunoHost documentation for this app: <https://yunohost.org/app_freshrss>
* Report a bug: <https://github.com/YunoHost-Apps/freshrss_ynh/issues>

## Developer info

Please send 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.

``` bash
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
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
Fix linter warnings (#120) - Upgrade to 1.18.1 2021-06-28 22:23:04 +02:00			`<!--`
			`N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator`
			`It shall NOT be edited by hand.`
			`-->`

Update README.md -Add badges 2020-08-14 11:34:13 +02:00			`# FreshRSS for YunoHost`
ajout du readme 2014-07-23 18:30:46 +02:00
Auto-update README 2022-10-02 22:24:51 +02:00			`[![Integration level](https://dash.yunohost.org/integration/freshrss.svg)](https://dash.yunohost.org/appci/app/freshrss) ![Working status](https://ci-apps.yunohost.org/ci/badges/freshrss.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/freshrss.maintain.svg)`
Set badge to SVG (#110) 2021-01-25 10:33:37 +01:00			`[![Install FreshRSS with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=freshrss)`
Add "install with yunohost" button + short FreshRSS description 2017-07-09 17:53:34 +02:00
Fix linter warnings (#120) - Upgrade to 1.18.1 2021-06-28 22:23:04 +02:00			`[Lire ce readme en français.](./README_fr.md)`

			`> *This package allows you to install FreshRSS 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.*`
Ajout TODO 2014-07-24 15:36:20 +02:00
Apply example_ynh 2019-07-02 00:38:57 +02:00			`## Overview`
update readme 2018-07-07 16:21:03 +02:00
Auto-update README 2022-10-02 23:03:51 +02:00			`An efficient but powerful RSS aggregator with a nice and mobile-friendly design, as well as extension and themes support.`
Apply example_ynh 2019-07-02 00:38:57 +02:00
Auto-update README 2022-10-02 23:03:51 +02:00
			Shipped version: 1.20.0~ynh1 (:warning: This is the `upgrade` branch. The [`master` branch](https://github.com/YunoHost-Apps/freshrss_ynh/tree/master) used in the catalog is currently on version 1.19.2\~ynh1.)
Apply example_ynh 2019-07-02 00:38:57 +02:00
Auto-update README 2022-10-02 22:24:51 +02:00
Fix linter warnings (#120) - Upgrade to 1.18.1 2021-06-28 22:23:04 +02:00			`Demo: https://demo.freshrss.org`
Add "install with yunohost" button + short FreshRSS description 2017-07-09 17:53:34 +02:00
Fix linter warnings (#120) - Upgrade to 1.18.1 2021-06-28 22:23:04 +02:00			`## Screenshots`
Readme: Add a screenshoot It's always nice to get an overview of the look of the software before installing :) 2018-07-08 11:56:31 +02:00
Auto-update README 2022-10-02 22:24:51 +02:00			`![Screenshot of FreshRSS](./doc/screenshots/screenshot.png)`
Apply example_ynh 2019-07-02 00:38:57 +02:00
Fix linter warnings (#120) - Upgrade to 1.18.1 2021-06-28 22:23:04 +02:00			`## Disclaimers / important information`
Merge branch 'master' into feature/upgrade-to-stretch 2018-07-21 12:22:22 +02:00
Apply example_ynh 2019-07-02 00:38:57 +02:00			`## Configuration`
FreshRss 1.9 (#38) * update to freshrss 1.9 * add api how to 2017-12-27 13:32:57 +01:00
Update README.md -Add badges 2020-08-14 11:34:13 +02:00			`API (mini) How To:`
			`* Into your user profile: Settings > profil`
FreshRss 1.9 (#38) * update to freshrss 1.9 * add api how to 2017-12-27 13:32:57 +01:00			`* Setup an API password`
Fixed Spelling in README.md (#109) 2021-01-25 10:24:18 +01:00			`* Check that the API is working: https://example.net/rss/api/greader.php`
			`* Setup your client with: username: ynh user, password: the password you just setup, URL https://example.tld/rss/api/greader.php`
Apply example_ynh 2019-07-02 00:38:57 +02:00
Fix linter warnings (#120) - Upgrade to 1.18.1 2021-06-28 22:23:04 +02:00			`## Documentation and resources`
Apply example_ynh 2019-07-02 00:38:57 +02:00
Auto-update README 2022-10-02 22:24:51 +02:00			`* Official app website: <http://freshrss.org/>`
			`* Official admin documentation: <https://freshrss.github.io/FreshRSS/>`
			`* Upstream app code repository: <https://github.com/FreshRSS/FreshRSS>`
			`* YunoHost documentation for this app: <https://yunohost.org/app_freshrss>`
			`* Report a bug: <https://github.com/YunoHost-Apps/freshrss_ynh/issues>`
Apply example_ynh 2019-07-02 00:38:57 +02:00
Fix linter warnings (#120) - Upgrade to 1.18.1 2021-06-28 22:23:04 +02:00			`## Developer info`
Apply example_ynh 2019-07-02 00:38:57 +02:00
Fix linter warnings (#120) - Upgrade to 1.18.1 2021-06-28 22:23:04 +02:00			`Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/freshrss_ynh/tree/testing).`
Apply example_ynh 2019-07-02 00:38:57 +02:00
Fix linter warnings (#120) - Upgrade to 1.18.1 2021-06-28 22:23:04 +02:00			`To try the testing branch, please proceed like that.`
Auto-update README 2022-10-02 22:24:51 +02:00
			``` bash
Apply example_ynh 2019-07-02 00:38:57 +02:00			`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`
Update README.md -Add badges 2020-08-14 11:34:13 +02:00			```
Fix linter warnings (#120) - Upgrade to 1.18.1 2021-06-28 22:23:04 +02:00
Auto-update README 2022-10-02 22:24:51 +02:00			`More info regarding app packaging: <https://yunohost.org/packaging_apps>`