From 97cf27c64ae2fe45d143b187bb47dea166c20606 Mon Sep 17 00:00:00 2001 From: oxy Date: Mon, 10 Mar 2025 01:02:43 +0800 Subject: [PATCH] Update README.md (cherry picked from commit bce374b794b51ec957a3b0699497bda9c2703905) --- README.md | 131 ++++++++++++++++++++++-------------------------------- 1 file changed, 53 insertions(+), 78 deletions(-) diff --git a/README.md b/README.md index 34474795..00aa8609 100644 --- a/README.md +++ b/README.md @@ -1,98 +1,74 @@ -# M3UAndroid +# πŸš€ M3UAndroid - Modern Streaming Player for Android - + + +![GitHub release](https://img.shields.io/github/v/release/oxyroid/M3UAndroid?color=blue) +![Android](https://img.shields.io/badge/Android-8.0%2B-brightgreen?logo=android) -M3U is a FREE stream media player on android devices, which made of jetpack compose. -Android 8.0 and above supported. - -### Device support - -Most Android devices, including smartphones, TVs, and tablets. - -### Screenshots +**M3UAndroid** is a feature-rich streaming media player built with modern Android development practices. Perfect for phones, tablets, and TV devices, delivering a seamless viewing experience powered by Jetpack Compose.
- - -
-
- - +
-### πŸ“’ Translations Wanted πŸ“’ +## ✨ Key Features -Please submit a pull request if you want to help with translation. +- πŸ“Ί Adaptive UI for mobile & TV +- 🎭 DLNA casting support +- πŸ” Smart stream analysis +- 🌐 Xtream protocol compatibility +- πŸ“₯ Playlist management +- πŸš€ Lightweight & ad-free +- πŸ‡ΊπŸ‡³ Multi-language support -Official: +## πŸ“Έ Screenshots -- [English](i18n/src/main/res/values) -- [Simplified Chinese](i18n/src/main/res/values-zh-rCN) -- (You can also provide better translations for the above languages via pull requests) +| Mobile Experience | TV Experience | +|--------------------|---------------| +| | | +| | | +| | | -From PRs: +> TV UI is going to be remade in the future... -- [Spanish](i18n/src/main/res/values-es-rES), - thanks [@sguinetti](https://github.com/sguinetti/M3UAndroid) -- [Romanian](i18n/src/main/res/values-ro-rRO), - thanks [@iboboc](https://github.com/iboboc/M3UAndroid) -- [Brazilian Portuguese](i18n/src/main/res/values-pt-rBR), - thanks [@Suburbanno](https://github.com/Suburbanno) +## ⬇️ Download Now +[![Recommand - Telegram Channel](https://img.shields.io/badge/Telegram-Channel-2CA5E0?style=for-the-badge&logo=telegram)](https://t.me/m3u_android) +[![GitHub Release](https://img.shields.io/badge/Download-GitHub%20Release-black?style=for-the-badge&logo=github)](https://github.com/oxyroid/M3UAndroid/releases/latest) +[![F-Droid](https://img.shields.io/badge/Download-F--Droid-1976D2?style=for-the-badge&logo=android)](https://f-droid.org/packages/com.m3u.androidApp) +[![IzzyOnDroid](https://img.shields.io/badge/Download-IzzyOnDroid-8A4182?style=for-the-badge)](https://apt.izzysoft.de/fdroid/index/apk/com.m3u.androidApp) -### Introduce +**Nightly Builds**: [Pre-release Packages](https://nightly.link/oxyroid/M3UAndroid/workflows/android/master/artifact.zip) -- [Basic](https://t.me/m3u_android/176) +## πŸ›  Tech Stack -### Features +- 100% Kotlin-first approach +- 🎨 Jetpack Compose UI toolkit +- 🧬 MVVM architecture pattern +- 🚦 Coroutines & Flows +- πŸ—ƒοΈ Room database +- πŸ’‰ Hilt dependency injection +- πŸ“¦ Modular architecture +- πŸŽ₯ ExoPlayer + FFmpeg core -- Playlist Management. -- Streaming media analysis capabilities. -- Xtream support. -- DLNA screencast. -- i18n (Internationalization). +## 🌍 Localization -### Android Development +Help us translate the app! Current support: -M3U is an app that attempts to use the latest libraries and tools. As a summary: +| Core Languages | Community Translations | +|----------------|------------------------| +| πŸ‡¬πŸ‡§ [English](i18n/src/main/res/values) | πŸ‡ͺπŸ‡Έ [Spanish](i18n/src/main/res/values-es-rES) by [@sguinetti](https://github.com/sguinetti) | +| πŸ‡¨πŸ‡³ [Simplified Chinese](i18n/src/main/res/values-zh-rCN) | πŸ‡·πŸ‡΄ [Romanian](i18n/src/main/res/values-ro-rRO) by [@iboboc](https://github.com/iboboc) | +| | πŸ‡§πŸ‡· [Portuguese (BR)](i18n/src/main/res/values-pt-rBR) by [@Suburbanno](https://github.com/Suburbanno) | -- Entirely written in Kotlin. -- UI completely written in Jetpack Compose. -- Material3 design system. -- Uses Kotlin Coroutines throughout. -- Uses many of the Architecture Components, including: Room, Lifecycle, Navigation. -- Uses Hilt for dependency injection. -- Uses Lint Checks for code scanning. -- Uses KSP & KotlinPoet for Code Generating. -- FFmepg-kit & ExoPlayer. +## 🀝 Contribution -### Installation +We welcome all contributions! Here's how you can help: +- πŸ› Report bugs via Issues +- πŸ’‘ Suggest new features +- πŸ“ Improve documentation +- πŸ”§ Submit code changes -[](https://github.com/oxyroid/M3UAndroid/releases/latest) -[](https://f-droid.org/packages/com.m3u.androidApp) -[](https://apt.izzysoft.de/fdroid/index/apk/com.m3u.androidApp) -> Get the SNAPSHOT -> package [here](https://nightly.link/oxyroid/M3UAndroid/workflows/android/master/artifact.zip) - -### Community - -You can join the [Telegram Channel](https://t.me/m3u_android) for update information and **alpha & -beta packages**. - -You can also join the [Telegram Group](https://t.me/m3u_android_chat) for discussing. - -### Contributing - -View this [file](CONTRIBUTING.md) to learn about how to contribute this repository. - -Refer to the [file](RULES.md) to learn about the Code Specification of this repository. - -### Star History +## πŸ“ˆ Project Growth @@ -102,7 +78,6 @@ Refer to the [file](RULES.md) to learn about the Code Specification of this repo -### License +## πŸ“œ License -M3UAndroid is distributed under the terms of the Apache License (Version 2.0). See -the [license](LICENSE) for more information. +Distributed under the **GPL 3.0**. See [LICENSE](LICENSE) for details.