From 3eae2f3fde28d7a364f4a0f3c708c7c81c1971a4 Mon Sep 17 00:00:00 2001
From: Chris <182387676+whoopsi-daisy@users.noreply.github.com>
Date: Sun, 12 Oct 2025 19:26:22 +0200
Subject: [PATCH] docs: improve README.md
Improve structure and consistency, fix grammar and spelling issues, reorder content for clarity, add GitHub download button, update Discord badge to a more suitable version, and include various other improvements
---
README.md | 140 +++++++++++++++++++++++++++---------------------------
1 file changed, 71 insertions(+), 69 deletions(-)
diff --git a/README.md b/README.md
index e16dcd73..550f5649 100644
--- a/README.md
+++ b/README.md
@@ -5,30 +5,30 @@
-
+
-
+
-
+
-
+
-### π§ͺ Beta testing
+### π§ͺ 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.
+To access the Streamyfin beta, you need to subscribe to the Member tier (or higher) on [Patreon](https://www.patreon.com/streamyfin). This grants you immediate access to the β π§ͺ-beta-releases channel on Discord and lets me know youβve subscribed. This is where I share APKs and IPAs. It does not provide automatic TestFlight access, so please send me a DM (Cagemaster) with the email you use for Apple so we can add you manually.
-**Note**: Everyone who is actively contributing to the source code of Streamyfin will have automatic access to the betas.
+**Note**: Anyone actively contributing to Streamyfinβs source code will receive automatic access to beta releases.
## π Getting Started
-### Prerequisites
+### βοΈ Prerequisites
-- Ensure you have an active Jellyfin server.
-- Make sure your device is connected to the same network as your Jellyfin server.
+- Confirm your Jellyfin server is running
+- Verify your device is on the same network as the Jellyfin server
## π Contributing
-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.
+We welcome contributions that improve Streamyfin. Start by forking the repository and submitting a pull request. For major changes or new features, please open an issue first to discuss your ideas and ensure alignment with the project.
-### π¨βπ» Development info
+### π¨βπ» Development Info
1. Use node `>20`
2. Install dependencies `bun i && bun run submodule-reload`
3. Make sure you have xcode and/or android studio installed. (follow the guides for expo: https://docs.expo.dev/workflow/android-studio-emulator/)
4. Install BiomeJS extension in VSCode/Your IDE (https://biomejs.dev/)
4. run `npm run prebuild`
-5. Create an expo dev build by running `npm run ios` or `npm run android`. This will open a simulator on your computer and run the app.
+5. Create an expo dev build by running `npm run ios` or `npm run android`. This will open a simulator on your computer and run the app
For the TV version suffix the npm commands with `:tv`.
`npm run prebuild:tv`
`npm run ios:tv or npm run android:tv`
-## π License
+## π Get in Touch with Us
-Streamyfin is licensed under the Mozilla Public License 2.0 (MPL-2.0).
-This means you are free to use, modify, and distribute this software. The MPL-2.0 is a copyleft license that allows for more flexibility in combining the software with proprietary code.
-Key points of the MPL-2.0:
+Feel free to join our Discord server: [](https://discord.gg/BuGG9ZNhaE)
-- You can use the software for any purpose
-- You can modify the software and distribute modified versions
-- You must include the original copyright and license notices
-- You must disclose your source code for any modifications to the covered files
-- Larger works may combine MPL code with code under other licenses
-- MPL-licensed components must remain under the MPL, but the larger work can be under a different license
-- For the full text of the license, please see the LICENSE file in this repository
+Need support or have any questions:
-## π Connect with Us
+- GitHub Issues: Report bugs or request features [here](https://github.com/streamyfin/streamyfin/issues)
+- Email: Reach out at [developer@streamyfin.app](mailto:developer@streamyfin.app)
+- Discord: Join our server at
-Join our Discord: [](https://discord.gg/BuGG9ZNhaE)
-
-Need support or have questions:
-
-- GitHub Issues: Report bugs or request features [here](https://github.com/streamyfin/streamyfin/issues)
-- Email: [developer@streamyfin.app](mailto:developer@streamyfin.app)
## β FAQ
-1. Q: Why can't I see my libraries in Streamyfin?
- A: Make sure your server is running one of the latest versions and that you have at least one library that isn't audio only.
-2. Q: Why can't I see my music library?
- A: We don't currently support music and are unlikely to support music in the near future.
+1. Q: Why can't I see my libraries in Streamyfin?
+ A: Make sure your server is running one of the latest versions and that you have at least one library that isn't audio only
+2. Q: Why can't I see my music library?
+ A: We don't currently support music and are unlikely to support music in the near future
## π Credits
-Streamyfin is developed by [Fredrik Burmester](https://github.com/fredrikburmester) and is not affiliated with Jellyfin. The app is built with Expo, React Native, and other open-source libraries.
+Streamyfin is developed by [Fredrik Burmester](https://github.com/fredrikburmester) and is not affiliated with Jellyfin. The app is built using Expo, React Native, and other open-source libraries.
-## β¨ Acknowledgements
-
-We would like to thank the Jellyfin team for their great software and awesome support on discord.
-
-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:
@@ -228,21 +210,41 @@ Thanks to the following contributors for their significant contributions:
-And all other developers who have contributed to Streamyfin, thank you for your contributions.
+## β¨ Acknowledgements
-I'd also like to thank the following people and projects for their contributions to Streamyfin:
+We would like to thank the Jellyfin team for their excellent software and support on Discord.
+
+Special thanks to the official Jellyfin clients, which have served as an inspiration for Streamyfin.
+
+We also thank all other developers who have contributed to Streamyfin, your efforts are greatly appreciated.
+
+A special mention to the following people and projects for their contributions:
+
+- [Reiverr](https://github.com/aleksilassila/reiverr) for invaluable help with understanding the Jellyfin API
+- [Jellyfin TS SDK](https://github.com/jellyfin/jellyfin-sdk-typescript) for providing the TypeScript SDK
+- [Seerr](https://github.com/seerr-team/seerr) for enabling API integration with their project
-- [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.
-- [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
[](https://star-history.com/#streamyfin/streamyfin&Date)
+## π License
+
+Streamyfin is licensed under the Mozilla Public License 2.0 (MPL-2.0).
+This means you are free to use, modify, and distribute this software. The MPL-2.0 is a copyleft license that allows for more flexibility in combining the software with proprietary code.
+Key points of the MPL-2.0:
+
+- You can use the software for any purpose
+- You can modify the software and distribute modified versions
+- You must include the original copyright and license notices
+- You must disclose your source code for any modifications to the covered files
+- Larger works may combine MPL code with code under other licenses
+- MPL-licensed components must remain under the MPL, but the larger work can be under a different license
+- For the full text of the license, please see the LICENSE file in this repository
+
## β οΈ Disclaimer
-Streamyfin does not promote, support, or condone piracy in any form. The app is intended solely for streaming media that you personally own and control. It does not provide or include any media content. Any discussions or support requests related to piracy are strictly prohibited across all our channels.
+Streamyfin does not promote, support, or condone piracy in any form. The app is intended solely for streaming media that you personally own and control. It does not provide or include any media content. Any discussions, support requests, or references to piracy, as well as any tools, software, or websites related to piracy, are strictly prohibited across all our channels.
## π€ Sponsorship
VPS hosting generously provided by [Hexabyte](https://hexabyte.se/en/vps/?currency=eur) and [SweHosting](https://swehosting.se/en/#tj%C3%A4nster)