1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/freshrss_ynh.git synced 2024-09-03 18:36:33 +02:00
freshrss_ynh/README.md

51 lines
2 KiB
Markdown
Raw Normal View History

<!--
2024-05-12 17:39:06 +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.
-->
2020-08-14 11:34:13 +02:00
# FreshRSS for YunoHost
2014-07-23 18:30:46 +02:00
2023-02-23 23:06:05 +01: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)
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)
2024-05-12 17:39:06 +02:00
*[Read this README in other languages.](./ALL_README.md)*
2024-05-12 17:39:06 +02:00
> *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.*
2014-07-24 15:36:20 +02:00
2019-07-02 00:38:57 +02:00
## Overview
2018-07-07 16:21:03 +02:00
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.
2019-07-02 00:38:57 +02:00
2022-10-02 23:03:51 +02:00
**Shipped version:** 1.24.0~ynh1
2022-10-02 22:24:51 +02:00
2024-05-12 17:39:06 +02:00
**Demo:** <https://demo.freshrss.org>
## Screenshots
2022-10-02 22:24:51 +02:00
![Screenshot of FreshRSS](./doc/screenshots/screenshot.png)
2019-07-02 00:38:57 +02:00
## Documentation and resources
2019-07-02 00:38:57 +02:00
2024-05-12 17:39:06 +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 Store: <https://apps.yunohost.org/app/freshrss>
- Report a bug: <https://github.com/YunoHost-Apps/freshrss_ynh/issues>
2019-07-02 00:38:57 +02:00
## Developer info
2019-07-02 00:38:57 +02:00
2024-05-12 17:39:06 +02:00
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/freshrss_ynh/tree/testing).
2019-07-02 00:38:57 +02:00
2024-05-12 17:39:06 +02:00
To try the `testing` branch, please proceed like that:
2022-10-02 22:24:51 +02:00
2024-05-12 17:39:06 +02:00
```bash
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
2020-08-14 11:34:13 +02:00
```
2022-10-02 22:24:51 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>