1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/miniflux_ynh.git synced 2024-09-03 19:45:58 +02:00
miniflux_ynh/README.md

52 lines
2 KiB
Markdown
Raw Normal View History

2021-05-22 09:28:38 +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.
-->
2021-05-21 14:13:08 +02:00
# Miniflux for YunoHost
2021-06-06 21:13:44 +02:00
[![Integration level](https://dash.yunohost.org/integration/miniflux.svg)](https://dash.yunohost.org/appci/app/miniflux) ![](https://ci-apps.yunohost.org/ci/badges/miniflux.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/miniflux.maintain.svg)
[![Install Miniflux with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=miniflux)
2021-05-21 14:13:08 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2021-06-06 21:13:44 +02:00
> *This package allows you to install Miniflux quickly and simply on a YunoHost server.
2021-05-22 09:28:38 +02:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
2021-05-21 14:13:08 +02:00
## Overview
2021-05-22 09:28:38 +02:00
Minimalist and opinionated RSS feed reader
2021-05-21 14:13:08 +02:00
2021-07-09 09:39:16 +02:00
**Shipped version:** 2.0.31~ynh2
2021-05-21 14:13:08 +02:00
2021-05-22 09:28:38 +02:00
## Screenshots
2021-05-21 14:13:08 +02:00
2021-06-06 21:13:44 +02:00
![](./doc/screenshots/overview.png)
2021-05-21 14:13:08 +02:00
2021-05-22 09:28:38 +02:00
## Disclaimers / important information
2021-05-21 14:13:08 +02:00
2021-05-22 09:28:38 +02:00
## Configuration
2021-05-21 14:13:08 +02:00
2021-05-22 09:28:38 +02:00
You can also configure Miniflux by editing this file `/var/www/miniflux/miniflux.conf` using the [documentation](https://miniflux.app/docs/configuration.html).
## Documentation and resources
* Official app website: https://miniflux.app/
* Official admin documentation: https://miniflux.app/docs/index.html
2021-06-06 21:13:44 +02:00
* Upstream app code repository: https://github.com/miniflux/v2
2021-05-22 09:28:38 +02:00
* YunoHost documentation for this app: https://yunohost.org/app_miniflux
* Report a bug: https://github.com/YunoHost-Apps/miniflux_ynh/issues
2021-05-21 14:13:08 +02:00
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/miniflux_ynh/tree/testing).
To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/miniflux_ynh/tree/testing --debug
or
sudo yunohost app upgrade miniflux -u https://github.com/YunoHost-Apps/miniflux_ynh/tree/testing --debug
```
2021-05-22 09:28:38 +02:00
**More info regarding app packaging:** https://yunohost.org/packaging_apps