mirror of
https://github.com/KRTirtho/spotube.git
synced 2026-08-05 19:59:51 +00:00
docs: update README.md with enhanced branding, features, and community information for improved user engagement
This commit is contained in:
parent
12ef478b0e
commit
452d739c5f
95
README.md
95
README.md
@ -1,48 +1,63 @@
|
|||||||
This is a Kotlin Multiplatform project targeting Android, iOS, Desktop (JVM).
|
<div align="center">
|
||||||
|
<img width="600" src="assets/branding/spotube_banner.png" alt="Spotube Logo">
|
||||||
|
|
||||||
* [/composeApp](./composeApp/src) is for code that will be shared across your Compose Multiplatform applications.
|
A cross-platform extensible open-source music streaming platform.<br>
|
||||||
It contains several subfolders:
|
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!
|
||||||
- [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.
|
|
||||||
|
|
||||||
* [/iosApp](./iosApp/iosApp) contains iOS applications. Even if you’re sharing your UI with Compose Multiplatform,
|
<a href="https://spotube.krtirtho.dev"><img alt="Visit the website" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/documentation/website_vector.svg"></a>
|
||||||
you need this entry point for your iOS app. This is also where you should add SwiftUI code for your project.
|
<a href="https://discord.gg/uJ94vxB6vg"><img alt="Discord Server" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/social/discord-plural_vector.svg"></a>
|
||||||
|
|
||||||
### Build and Run Android Application
|
<a href="https://patreon.com/krtirtho"><img alt="Support me on Patron" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/donate/patreon-singular_vector.svg"></a>
|
||||||
|
<a href="https://www.buymeacoffee.com/krtirtho"><img alt="Buy me a Coffee" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/donate/buymeacoffee-singular_vector.svg"></a>
|
||||||
|
|
||||||
To build and run the development version of the Android app, use the run configuration from the run widget
|
[](https://news.ycombinator.com/item?id=39066136)
|
||||||
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
|
|
||||||
```
|
|
||||||
|
|
||||||
### Build and Run Desktop (JVM) Application
|
<a href="https://opencollective.com/spotube"><img src="https://opencollective.com/spotube/donate/button.png?color=blue" alt="Donate to our Open Collective" height="45"></a>
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
Learn more about [Kotlin Multiplatform](https://www.jetbrains.com/help/kotlin-multiplatform-dev/get-started.html)…
|

|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
## 🌃 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
|
||||||
|
|
||||||
|
<a href="https://github.com/KRTirtho/spotube/actions"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/KRTirtho/spotube/spotube-release-binary.yml?+label=Build%20Status"></a>
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
<div align="center"><h4>© Copyright Spotube 2026</h4></div>
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user