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

# Vore for YunoHost

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

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

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

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

A simple, multi-tenant feed reader

### Client:

- rss and atom support
- minimal, simple, reliable, fast
- refresh your feeds automatically
- display a chronological list of feed items


**Shipped version:** 2023.05.15~ynh2

**Demo:** https://vore.website/j3s

## Screenshots

![Screenshot of Vore](./doc/screenshots/example.jpg)

## Documentation and resources

* Official app website: <https://git.j3s.sh/vore>
* Official admin documentation: <https://j3s.sh/thought/vore-a-new-rss-feed-reader.html>
* Upstream app code repository: <https://git.j3s.sh/vore/tree/main/>
* YunoHost documentation for this app: <https://yunohost.org/app_vore>
* Report a bug: <https://github.com/YunoHost-Apps/vore_ynh/issues>

## Developer info

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/vore_ynh/tree/testing).

To try the testing branch, please proceed like that.

``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/vore_ynh/tree/testing --debug
or
sudo yunohost app upgrade vore -u https://github.com/YunoHost-Apps/vore_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>