ttrss_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.
-->

# Tiny Tiny RSS for YunoHost

[![Integration level](https://dash.yunohost.org/integration/ttrss.svg)](https://dash.yunohost.org/appci/app/ttrss) ![Working status](https://ci-apps.yunohost.org/ci/badges/ttrss.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/ttrss.maintain.svg)

[![Install Tiny Tiny RSS with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ttrss)

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

> *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.

### Features

- feed aggregation/syndication,
- OPML import/export,
- multiple ways to share stuff: export RSS feeds, plugins for various social sites, sharing by URL, etc,
- Plugins and themes,
- podcasts,
- flexible article filtering


**Shipped version:** 20231202~ynh3

**Demo:** https://demo.tt-rss.org/

## Screenshots

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

## Documentation and resources

* Official app website: <https://tt-rss.org>
* Official admin documentation: <https://tt-rss.org/wiki.php>
* Upstream app code repository: <https://gitlab.tt-rss.org/tt-rss/tt-rss>
* YunoHost Store: <https://apps.yunohost.org/app/ttrss>
* Report a bug: <https://github.com/YunoHost-Apps/ttrss_ynh/issues>

## Developer info

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.

``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/ttrss_ynh/tree/testing --debug
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>
Auto-update README 2021-12-28 10:42:55 +01:00			`<!--`
Auto-update README 2024-02-19 21:37:59 +01:00			`N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/readme_generator`
Auto-update README 2021-12-28 10:42:55 +01:00			`It shall NOT be edited by hand.`
			`-->`

cleaning up 2020-08-14 23:36:09 +02:00			`# Tiny Tiny RSS for YunoHost`
Create README.md 2013-11-24 11:41:11 +01:00
Auto-update README 2023-02-27 12:47:53 +01:00			`[![Integration level](https://dash.yunohost.org/integration/ttrss.svg)](https://dash.yunohost.org/appci/app/ttrss) ![Working status](https://ci-apps.yunohost.org/ci/badges/ttrss.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/ttrss.maintain.svg)`

Set SVG badge 2020-12-26 23:11:34 +01:00			`[![Install Tiny Tiny RSS with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ttrss)`
Normalization from example_ynh 2019-05-01 20:35:48 +02:00
add README_fr 2020-06-10 16:01:00 +02:00			`[Lire ce readme en français.](./README_fr.md)`

Auto-update README 2021-12-28 10:42:55 +01:00			`> *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.*`
Normalization from example_ynh 2019-05-01 20:35:48 +02:00
			`## Overview`

			`Tiny Tiny RSS is a free and open source web-based news feed (RSS/Atom) reader and aggregator.`

Auto-update README 2023-09-06 19:00:29 +02:00			`### Features`
Normalization from example_ynh 2019-05-01 20:35:48 +02:00
Auto-update README 2023-01-19 09:09:17 +01:00			`- feed aggregation/syndication,`
Auto-update README 2021-12-28 10:42:55 +01:00			`- OPML import/export,`
			`- multiple ways to share stuff: export RSS feeds, plugins for various social sites, sharing by URL, etc,`
			`- Plugins and themes,`
			`- podcasts,`
			`- flexible article filtering`
Normalization from example_ynh 2019-05-01 20:35:48 +02:00
Upgrade (#136) * Apply example_ynh * Fix #49 * Fix #75 * Auto-update README * Update check_process Co-authored-by: yunohost-bot <yunohost@yunohost.org> 2022-07-06 06:41:20 +02:00
Auto-update README 2023-12-07 13:47:21 +01:00			`Shipped version: 20231202~ynh3`
Normalization from example_ynh 2019-05-01 20:35:48 +02:00
Auto-update README 2023-12-06 14:41:10 +01:00			`Demo: https://demo.tt-rss.org/`
Normalization from example_ynh 2019-05-01 20:35:48 +02:00
Auto-update README 2021-12-28 10:42:55 +01:00			`## Screenshots`
Normalization from example_ynh 2019-05-01 20:35:48 +02:00
Auto-update README 2022-06-06 16:22:18 +02:00			`![Screenshot of Tiny Tiny RSS](./doc/screenshots/screenshot.png)`
Normalization from example_ynh 2019-05-01 20:35:48 +02:00
Auto-update README 2021-12-28 10:42:55 +01:00			`## Documentation and resources`
Normalization from example_ynh 2019-05-01 20:35:48 +02:00
Upgrade (#136) * Apply example_ynh * Fix #49 * Fix #75 * Auto-update README * Update check_process Co-authored-by: yunohost-bot <yunohost@yunohost.org> 2022-07-06 06:41:20 +02:00			`* Official app website: <https://tt-rss.org>`
			`* Official admin documentation: <https://tt-rss.org/wiki.php>`
PostgreSQL (#150) * switch to PHP * Update install * Update _common.sh * Update _common.sh * Update app.src * Update manifest.json * Auto-update README * Fix * Update remove * Update _common.sh * Update app.src * Fix * Remove cron * Update install * Update change_url * Update systemd.service * Update install * Update DESCRIPTION.md * Auto-update README * Fix * Update manifest.json * Update restore * Update app.src * Create migration * v2 * v2 * Auto-update README * Fix * Auto-update README * fix * fix * fix * Update restore * data_migration * Revert "data_migration" This reverts commit 1aea23fb527ae3dade359d4e0b553cd87d10442a. * fix * fix * Update manifest.toml * Update manifest.toml * Update manifest.toml * Auto-update README * fix * Update manifest.toml * Update manifest.toml * Auto-update README * Create PRE_UPGRADE_fr.md * fix * Auto-update README * Auto-update README * Update manifest.toml * Auto-update README --------- Co-authored-by: Yunohost-Bot <> Co-authored-by: yunohost-bot <yunohost@yunohost.org> 2023-12-03 13:01:47 +01:00			`* Upstream app code repository: <https://gitlab.tt-rss.org/tt-rss/tt-rss>`
Auto-update README 2023-10-31 15:39:16 +01:00			`* YunoHost Store: <https://apps.yunohost.org/app/ttrss>`
Auto-update README 2022-06-06 16:22:18 +02:00			`* Report a bug: <https://github.com/YunoHost-Apps/ttrss_ynh/issues>`
Normalization from example_ynh 2019-05-01 20:35:48 +02:00
Auto-update README 2021-12-28 10:42:55 +01:00			`## Developer info`
Normalization from example_ynh 2019-05-01 20:35:48 +02:00
Auto-update README 2021-12-28 10:42:55 +01:00			`Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/ttrss_ynh/tree/testing).`
Normalization from example_ynh 2019-05-01 20:35:48 +02:00
			`To try the testing branch, please proceed like that.`
Auto-update README 2022-06-06 16:22:18 +02:00
			``` bash
Normalization from example_ynh 2019-05-01 20:35:48 +02:00			`sudo yunohost app install https://github.com/YunoHost-Apps/ttrss_ynh/tree/testing --debug`
			`or`
			`sudo yunohost app upgrade ttrss -u https://github.com/YunoHost-Apps/ttrss_ynh/tree/testing --debug`
			```
Auto-update README 2021-12-28 10:42:55 +01:00
Auto-update README 2024-02-19 21:37:59 +01:00			`More info regarding app packaging: <https://yunohost.org/packaging_apps>`