diff --git a/README.md b/README.md index 1fb072b..63bd219 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,66 @@ -# Jellyfin app for YunoHost -Jellyfin Server +# Jellyfin for YunoHost + +[![Integration level](https://dash.yunohost.org/integration/jellyfin.svg)](https://dash.yunohost.org/appci/app/jellyfin) ![](https://ci-apps.yunohost.org/ci/badges/jellyfin.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/jellyfin.maintain.svg) +[![Install Jellyfin with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=jellyfin) + +## Overview +Jellyfin enables you to collect, manage, and stream your media. Run the Jellyfin server on your system and gain access to the leading free-software entertainment system, bells and whistles included. **Shipped version:** 10.6.4 -- [Yunohost project](https://yunohost.org) -- [Jellyfin website](https://github.com/jellyfin/jellyfin) +## Screenshots -![](https://www.ostechnix.com/wp-content/uploads/2019/03/jellyfin-logo-720x340.png) +![](https://jellyfin.org/images/screenshots/movie_full.png) +## Demo -[![Install Jellyfin with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=jellyfin) +* [Official demo](Link to a demo site for this app.) +## Configuration -### Installing guide +How to configure this app: From an admin panel, a plain file with SSH, or any other way. - App can be installed by YunoHost **admin web-interface** or by **running following command**: +## Documentation - $ sudo yunohost app install https://github.com/YunoHost-Apps/jellyfin_ynh + * Official documentation: Link to the official documentation of this app + * YunoHost documentation: If specific documentation is needed, feel free to contribute. - -### Upgrade this package: +## YunoHost specific features - $ sudo yunohost app upgrade jellyfin -u https://github.com/YunoHost-Apps/jellyfin_ynh +#### Multi-user support + + * Are LDAP and HTTP auth supported? + * Can the app be used by multiple users? + +#### Supported architectures + +* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/jellyfin%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/jellyfin/) +* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/jellyfin%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/jellyfin/) + +## Limitations + +* Any known limitations. + +## Additional information + +* Other info you would like to add about this app. + +## Links + + * Report a bug: https://github.com/YunoHost-Apps/jellyfin_ynh/issues + * App website: https://jellyfin.org/ + * Upstream app repository: https://github.com/jellyfin/jellyfin + * YunoHost website: https://yunohost.org/ + +--- + +## Developer info + +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/jellyfin_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/jellyfin_ynh/tree/testing --debug +or +sudo yunohost app upgrade jellyfin -u https://github.com/YunoHost-Apps/jellyfin_ynh/tree/testing --debug +```