diff --git a/README.md b/README.md index 3cc70ff2..c4efbca2 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,63 @@ -This is a Kotlin Multiplatform project targeting Android, iOS, Desktop (JVM). +
+ Spotube Logo -* [/composeApp](./composeApp/src) is for code that will be shared across your Compose Multiplatform applications. - It contains several subfolders: - - [commonMain](./composeApp/src/commonMain/kotlin) is for code that’s common for all targets. - - Other folders are for Kotlin code that will be compiled for only the platform indicated in the folder name. - For example, if you want to use Apple’s CoreCrypto for the iOS part of your Kotlin app, - the [iosMain](./composeApp/src/iosMain/kotlin) folder would be the right place for such calls. - Similarly, if you want to edit the Desktop (JVM) specific part, the [jvmMain](./composeApp/src/jvmMain/kotlin) - folder is the appropriate location. +A cross-platform extensible open-source music streaming platform.
+Bring your own music metadata/playlist/audio-source with plugins created by community or by yourself. A small step towards the decentralized music streaming era! -* [/iosApp](./iosApp/iosApp) contains iOS applications. Even if you’re sharing your UI with Compose Multiplatform, - you need this entry point for your iOS app. This is also where you should add SwiftUI code for your project. +Visit the website +Discord Server -### Build and Run Android Application +Support me on Patron +Buy me a Coffee -To build and run the development version of the Android app, use the run configuration from the run widget -in your IDE’s toolbar or build it directly from the terminal: -- on macOS/Linux - ```shell - ./gradlew :composeApp:assembleDebug - ``` -- on Windows - ```shell - .\gradlew.bat :composeApp:assembleDebug - ``` +[![HackerNews](https://hackerbadge.vercel.app/api?id=39066136&type=dark)](https://news.ycombinator.com/item?id=39066136) -### Build and Run Desktop (JVM) Application - -To build and run the development version of the desktop app, use the run configuration from the run widget -in your IDE’s toolbar or run it directly from the terminal: -- on macOS/Linux - ```shell - ./gradlew :composeApp:run - ``` -- on Windows - ```shell - .\gradlew.bat :composeApp:run - ``` - -### Build and Run iOS Application - -To build and run the development version of the iOS app, use the run configuration from the run widget -in your IDE’s toolbar or open the [/iosApp](./iosApp) directory in Xcode and run it from there. +Donate to our Open Collective --- -Learn more about [Kotlin Multiplatform](https://www.jetbrains.com/help/kotlin-multiplatform-dev/get-started.html)… \ No newline at end of file +![Spotube Desktop](assets/branding/spotube-screenshot.png) + +![Spotube Mobile](assets/branding/mobile-screenshots/combined.jpg) + +
+ +## 🌃 Features + +- 🧩 Plugin powered, supports any platform or custom music service through plugins. +- 🗺️ Community driven plugins for popular platforms or create your own. +- ⬇️ Freely downloadable tracks with tagged metadata. +- 🖥️ 📱 Cross-platform support. +- 🪶 Small size & less data usage. +- 🕒 Time synced lyrics regardless of the plugin support. +- ✋ No telemetry, diagnostics or user data collection. +- 🚀 Native performance. +- 📖 Open source/libre software. +- 🔉 Playback control is done locally, not on the server. + +### ⬇️ Download + +Download Spotube from the Official Website: https://spotube.cc + +### 🔄 Nightly Builds + +Grab the latest nightly builds of Spotube [from the Offical Website](https://spotube.cc/downloads/nightly). + +## 🕳️ Building from source + +GitHub Workflow Status + +You can compile Spotube's source code by [following these instructions](CONTRIBUTION.md#your-first-code-contribution). + +## 👥 The Spotube team + +- [Kingkor Roy Tirtho](https://github.com/KRTirtho) - The Founder, Maintainer and Lead Developer +- [Owen Connor](https://github.com/owencz1998) - The Cool Discord Moderator +- [Piotr Rogowski](https://github.com/karniv00l) - The MacOS Developer +- [Rusty Apple](https://github.com/RustyApple) - The Mysterious Unknown Guy + +## 💼 License + +Spotube is open source and licensed under the [AGPL-3.0-or-later](/LICENSE) License. + +

© Copyright Spotube 2026