From deae6ab21a28528e1f22e6b5a513bc7d00cdcd3f Mon Sep 17 00:00:00 2001 From: Chris <182387676+whoopsi-daisy@users.noreply.github.com> Date: Thu, 9 Oct 2025 21:51:02 +0200 Subject: [PATCH] docs: improve README.md - Rename Jellyseer to Seerr - Remove dots from feature list - Add download button linking to GitHub - Refine phrasing in Contributing section - Correct grammar and spelling errors --- README.md | 35 +++++++++++++++++------------------ 1 file changed, 17 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 6b10ae0a..e16dcd73 100644 --- a/README.md +++ b/README.md @@ -23,20 +23,20 @@ ## ๐ŸŒŸ Features - ๐Ÿš€ **Skip Intro / Credits Support** -- ๐Ÿ–ผ๏ธ **Trickplay images**: The new golden standard for chapter previews when seeking. -- ๐Ÿ“ฅ **Download media** (Experimental): Save your media locally and watch it offline. -- ๐Ÿ“ก **Chromecast** (Experimental): Cast your media to any Chromecast-enabled device. -- ๐Ÿ“ก **Settings management** (Experimental): Manage app settings for all your users with a JF plugin. -- ๐Ÿค– **Jellyseerr integration**: Request media directly in the app. -- ๐Ÿ‘๏ธ **Sessions View:** View all active sessions currently streaming on your server. +- ๐Ÿ–ผ๏ธ **Trickplay images**: The new golden standard for chapter previews when seeking +- ๐Ÿ“ฅ **Download media** (Experimental): Save your media locally and watch it offline +- ๐Ÿ“ก **Chromecast** (Experimental): Cast your media to any Chromecast-enabled device +- ๐Ÿ“ก **Settings management** (Experimental): Manage app settings for all your users with a JF plugin +- ๐Ÿค– **Seerr (former Jellyseerr) integration**: Request media directly in the app +- ๐Ÿ‘๏ธ **Sessions View:** View all active sessions currently streaming on your server ## ๐Ÿงช Experimental Features -Streamyfin includes some exciting experimental features like media downloading and Chromecast support. These features are still in development, and your patience and feedback are much appreciated as we work to improve them. +Streamyfin offers exciting experimental features such as media downloading and Chromecast support. These features are under active development, and your feedback and patience help us make them even better. ### ๐Ÿ“ฅ Downloading -Downloading works by using ffmpeg to convert an HLS stream into a video file on the device. This means that you can download and view any file you can stream! The file is converted by Jellyfin on the server in real time as it is downloaded. This means a **bit longer download times** but supports any file that your server can transcode. +Downloading works by using ffmpeg to convert an HLS stream into a video file on your device. This allows you to download and watch any content that you can stream. The file is converted by Jellyfin on the server in real time during the download. This may result in slightly longer download times, but it ensures compatibility with any file your server can transcode. ### ๐ŸŽฅ Chromecast @@ -46,7 +46,7 @@ Chromecast support is still in development, and we're working on improving it. C The Jellyfin Plugin for Streamyfin is a plugin you install into Jellyfin that holds all settings for the client Streamyfin. This allows you to synchronize settings across all your users, like for example: -- Auto log in to Jellyseerr without the user having to do anything +- Auto log in to Seerr without the user having to do anything - Choose the default languages - Set download method and search provider - Customize home screen @@ -64,15 +64,14 @@ The Jellyfin Plugin for Streamyfin is a plugin you install into Jellyfin that ho Check out our [Roadmap](https://github.com/users/fredrikburmester/projects/5) To see what we're working on next, we are always open to feedback and suggestions. Please let us know if you have any ideas or feature requests. -## ๐Ÿ“ฅ Get it now +## ๐Ÿ“ฅ Download Streamyfin
Get Streamyfin on App Store - Get the beta on Google Play + Get Streamyfin on Google Play Store + Get Streamyfin on Github
-Or download the APKs [here on GitHub](https://github.com/streamyfin/streamyfin/releases) for Android. - ### ๐Ÿงช Beta testing To access the Streamyfin beta, you need to subscribe to the Member tier (or higher) on [Patreon](https://www.patreon.com/streamyfin). This will give you immediate access to the โ ๐Ÿงช-public-beta channel on Discord and I'll know that you have subscribed. This is where I post APKs and IPAs. This won't give automatic access to the TestFlight, however, so you need to send me a DM with the email you use for Apple so that I can manually add you. @@ -88,7 +87,7 @@ To access the Streamyfin beta, you need to subscribe to the Member tier (or high ## ๐Ÿ™Œ Contributing -We welcome any help to make Streamyfin better. If you'd like to contribute, please fork the repository and submit a pull request. For major changes, it's best to open an issue first to discuss your ideas. +We appreciate all contributions that help make Streamyfin better. To get started, fork the repository and submit a pull request. For significant changes or new features, open an issue first to discuss your ideas and ensure alignment with the project. ### ๐Ÿ‘จโ€๐Ÿ’ป Development info @@ -124,7 +123,7 @@ Join our Discord: [![](https://dcbadge.limes.pink/api/server/https://discord.gg/ Need support or have questions: -- GitHub Issues: Report bugs or request features here. +- GitHub Issues: Report bugs or request features [here](https://github.com/streamyfin/streamyfin/issues) - Email: [developer@streamyfin.app](mailto:developer@streamyfin.app) ## โ“ FAQ @@ -144,7 +143,7 @@ We would like to thank the Jellyfin team for their great software and awesome su Special shoutout to the JF official clients for being an inspiration to ours. -### ๐Ÿ† Core Developers +## ๐Ÿ† Core Developers Thanks to the following contributors for their significant contributions: @@ -235,8 +234,8 @@ I'd also like to thank the following people and projects for their contributions - [Reiverr](https://github.com/aleksilassila/reiverr) for great help with understanding the Jellyfin API. - [Jellyfin TS SDK](https://github.com/jellyfin/jellyfin-sdk-typescript) for the TypeScript SDK. -- [Jellyseerr](https://github.com/Fallenbagel/jellyseerr) for enabling API integration with their project. -- The Jellyfin devs for always being helpful in the Discord. +- [Seerr](https://github.com/seerr-team/seerr) for enabling API integration with their project. +- The Jellyfin developers for always being helpful on Discord. ## โญ Star History