1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/ttrss_ynh.git synced 2024-10-01 13:34:46 +02:00
ttrss_ynh/README.md

60 lines
2.1 KiB
Markdown
Raw Normal View History

2021-12-28 10:42:55 +01: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.
-->
2020-08-14 23:36:09 +02:00
# Tiny Tiny RSS for YunoHost
2013-11-24 11:41:11 +01:00
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)
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)
2019-05-01 20:35:48 +02:00
2020-06-10 16:01:00 +02:00
*[Lire ce readme en français.](./README_fr.md)*
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.*
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.
2023-09-06 19:00:29 +02:00
### Features
2019-05-01 20:35:48 +02:00
2023-01-19 09:09:17 +01:00
- feed aggregation/syndication,
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
2019-05-01 20:35:48 +02:00
2023-12-06 10:46:44 +01:00
**Shipped version:** 20231202~ynh2
2019-05-01 20:35:48 +02:00
2023-12-06 14:41:10 +01:00
**Demo:** https://demo.tt-rss.org/
2019-05-01 20:35:48 +02:00
2021-12-28 10:42:55 +01:00
## Screenshots
2019-05-01 20:35:48 +02:00
2022-06-06 16:22:18 +02:00
![Screenshot of Tiny Tiny RSS](./doc/screenshots/screenshot.png)
2019-05-01 20:35:48 +02:00
2021-12-28 10:42:55 +01:00
## Documentation and resources
2019-05-01 20:35:48 +02:00
* 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>
2023-10-31 15:39:16 +01:00
* YunoHost Store: <https://apps.yunohost.org/app/ttrss>
2022-06-06 16:22:18 +02:00
* Report a bug: <https://github.com/YunoHost-Apps/ttrss_ynh/issues>
2019-05-01 20:35:48 +02:00
2021-12-28 10:42:55 +01:00
## Developer info
2019-05-01 20:35:48 +02:00
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).
2019-05-01 20:35:48 +02:00
To try the testing branch, please proceed like that.
2022-06-06 16:22:18 +02:00
``` bash
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
```
2021-12-28 10:42:55 +01:00
2022-06-06 16:22:18 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>