1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/reiverr_ynh.git synced 2024-09-03 20:16:14 +02:00
reiverr_ynh/README.md

50 lines
2 KiB
Markdown
Raw Normal View History

2023-10-08 18:31:27 +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.
-->
2023-10-10 19:29:46 +02:00
# Reiverr for YunoHost
2023-10-08 18:31:27 +02:00
2023-10-10 19:29:46 +02:00
[![Integration level](https://dash.yunohost.org/integration/reiverr.svg)](https://dash.yunohost.org/appci/app/reiverr) ![Working status](https://ci-apps.yunohost.org/ci/badges/reiverr.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/reiverr.maintain.svg)
[![Install Reiverr with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=reiverr)
2023-10-08 18:31:27 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2023-10-10 19:29:46 +02:00
> *This package allows you to install Reiverr quickly and simply on a YunoHost server.
2023-10-08 18:31:27 +02:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2023-10-31 15:32:46 +01:00
Reiverr is a project that aims to create a single UI for interacting with TMDB, Jellyfin, Radarr and Sonarr, as well as be an alternative to Overseerr.
2023-10-08 18:31:27 +02:00
2023-10-10 19:29:46 +02:00
**Shipped version:** 0.8.0~ynh1
2023-10-08 18:31:27 +02:00
## Screenshots
2023-10-31 15:32:46 +01:00
![Screenshot of Reiverr](./doc/screenshots/screenshot.png)
## :red_circle: Antifeatures
- **Alpha software**: Early development stage. May contain changing or unstable features, bugs, and security vulnerability.
2023-10-08 18:31:27 +02:00
## Documentation and resources
2023-10-10 19:29:46 +02:00
* Upstream app code repository: <https://github.com/aleksilassila/reiverr>
2023-10-31 15:32:46 +01:00
* YunoHost Store: <https://apps.yunohost.org/app/reiverr>
2023-10-10 19:29:46 +02:00
* Report a bug: <https://github.com/YunoHost-Apps/reiverr_ynh/issues>
2023-10-08 18:31:27 +02:00
## Developer info
2023-10-10 19:29:46 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/reiverr_ynh/tree/testing).
2023-10-08 18:31:27 +02:00
To try the testing branch, please proceed like that.
``` bash
2023-10-10 19:29:46 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/reiverr_ynh/tree/testing --debug
2023-10-08 18:31:27 +02:00
or
2023-10-10 19:29:46 +02:00
sudo yunohost app upgrade reiverr -u https://github.com/YunoHost-Apps/reiverr_ynh/tree/testing --debug
2023-10-08 18:31:27 +02:00
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>