Update README.md

Adding Header, body tags and some responsive CSS.
This commit is contained in:
DEBAJYOTI GHOSH 2024-03-23 09:59:59 +05:30 committed by GitHub
parent f4dce2f611
commit 9f33f6b0b8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

175
README.md
View File

@ -1,55 +1,68 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Spotube</title>
<style>
/* Responsive CSS */
@media (max-width: 600px) {
img {
max-width: 100%;
height: auto;
}
}
</style>
</head>
<body>
<div align="center"> <div align="center">
<img width="600" src="assets/spotube_banner.png" alt="Spotube Logo"> <img width="600" src="assets/spotube_banner.png" alt="Spotube Logo">
<p>An open source, cross-platform Spotify client compatible across multiple platforms<br /> utilizing Spotify's
An open source, cross-platform Spotify client compatible across multiple platforms<br /> data API and YouTube, Piped.video or JioSaavn as an audio source,<br /> eliminating the need for Spotify
utilizing Spotify's data API and YouTube, Piped.video or JioSaavn as an audio source,<br /> Premium</p>
eliminating the need for Spotify Premium <p>Btw it's not just another Electron app 😉</p>
<a href="https://spotube.krtirtho.dev"><img alt="Visit the website" height="56"
Btw it's not just another Electron app 😉 src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/documentation/website_vector.svg"></a>
<a href="https://discord.gg/uJ94vxB6vg"><img alt="Discord Server" height="56"
<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> src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/social/discord-plural_vector.svg"></a>
<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> <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://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"
<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> src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/donate/buymeacoffee-singular_vector.svg"></a>
<p>HackerNews</p>
[![HackerNews](https://hackerbadge.vercel.app/api?id=39066136&type=dark)](https://news.ycombinator.com/item?id=39066136) <a href="https://opencollective.com/spotube"><img
src="https://opencollective.com/spotube/donate/button.png?color=blue"
<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> alt="Donate to our Open Collective" height="45"></a>
<p>Spotube Desktop</p>
--- <p>Spotube Mobile</p>
![Spotube Desktop](assets/spotube-screenshot.png)
![Spotube Mobile](assets/mobile-screenshots/combined.png)
</div> </div>
<div align="center">
## 🌃 Features <h2>🌃 Features</h2>
<ul>
- 🚫 No ads, thanks to the use of public & free Spotify and YT Music APIs¹ <li>🚫 No ads, thanks to the use of public & free Spotify and YT Music APIs¹</li>
- ⬇️ Freely downloadable tracks <li>⬇️ Freely downloadable tracks</li>
- 🖥️ 📱 Cross-platform support <li>🖥️ 📱 Cross-platform support</li>
- 🪶 Small size & less data usage <li>🪶 Small size & less data usage</li>
- 🕵️ Anonymous/guest login <li>🕵️ Anonymous/guest login</li>
- 🕒 Time synced lyrics <li>🕒 Time synced lyrics</li>
- ✋ No telemetry, diagnostics or user data collection <li>✋ No telemetry, diagnostics or user data collection</li>
- 🚀 Native performance <li>🚀 Native performance</li>
- 📖 Open source/libre software <li>📖 Open source/libre software</li>
- 🔉 Playback control is done locally, not on the server <li>🔉 Playback control is done locally, not on the server</li>
</ul>
**¹** It is still **recommended** to support creators by engaging with their YouTube channels/Spotify tracks (or preferably by buying their merch/concert tickets/physical media). <p>¹ It is still recommended to support creators by engaging with their YouTube channels/Spotify tracks (or
preferably by buying their merch/concert tickets/physical media).</p>
### ❌ Unsupported features <h2>❌ Unsupported features</h2>
<ul>
- 🗣️ **Spotify Shows & Podcasts:** Shows and Podcasts will <ins>**never be supported**</ins> because the audio tracks are <ins>_only_</ins> available on Spotify and accessing them would require Spotify Premium. <li>🗣️ Spotify Shows & Podcasts: Shows and Podcasts will <ins>never be supported</ins> because the audio
- 🎧 **Spotify Listen Along:** [Coming soon!](https://github.com/KRTirtho/spotube/issues/8) tracks are <ins>only</ins> available on Spotify and accessing them would require Spotify Premium.</li>
<li>🎧 Spotify Listen Along: Coming soon!</li>
## 📜 ⬇️ Installation guide </ul>
<h2>📜 ⬇️ Installation guide</h2>
New versions usually release every 3-4 months.<br /> <p>New versions usually release every 3-4 months.<br /> This handy table lists all the methods you can use to
This handy table lists all the methods you can use to install Spotube: install Spotube:</p>
<table> <table>
<tr> <tr>
<th>Platform</th> <th>Platform</th>
@ -57,32 +70,34 @@ This handy table lists all the methods you can use to install Spotube:
</tr> </tr>
<tr> <tr>
<td>Windows</td> <td>Windows</td>
<td> <td><a
<a href="https://github.com/KRTirtho/spotube/releases/latest/download/Spotube-windows-x86_64-setup.exe"> href="https://github.com/KRTirtho/spotube/releases/latest/download/Spotube-windows-x86_64-setup.exe"><img
<img width="220" alt="Windows Download" src="https://get.todoist.help/hc/article_attachments/4403191721234/WindowsButton.svg"> width="220" alt="Windows Download"
</a> src="https://get.todoist.help/hc/article_attachments/4403191721234/WindowsButton.svg"></a>
</td>
</tr> </tr>
<tr> <tr>
<td>MacOS</td> <td>MacOS</td>
<td> <td><a href="https://github.com/KRTirtho/spotube/releases/latest/download/Spotube-macos-universal.dmg"><img
<a href="https://github.com/KRTirtho/spotube/releases/latest/download/Spotube-macos-universal.dmg"> width="220" alt="MacOS Download"
<img width="220" alt="MacOS Download" src="https://reachify.io/wp-content/uploads/2018/09/mac-download-button-1.png"> src="https://reachify.io/wp-content/uploads/2018/09/mac-download-button-1.png"></a></td>
</a>
</td>
</tr> </tr>
<tr> <tr>
<td>Android</td> <td>Android</td>
<td> <td>
<a href="https://play.google.com/store/apps/details?id=oss.krtirtho.spotube"> <a href="https://play.google.com/store/apps/details?id=oss.krtirtho.spotube">
<img width="220" alt="Get it on Google Play" src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png"> <img width="220" alt="Get it on Google Play"
src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png">
</a> </a>
<br> <br>
<a href="https://github.com/KRTirtho/spotube/releases/latest/download/Spotube-android-all-arch.apk"> <a href="https://github.com/KRTirtho/spotube/releases/latest/download/Spotube-android-all-arch.apk">
<img width="220" alt="APK download" src="https://user-images.githubusercontent.com/114044633/223920025-83687de0-e463-4c5d-8122-e06e4bb7d40c.png"> <img width="220" alt="APK download"
src="https://user-images.githubusercontent.com/114044633/223920025-83687de0-e463-4c5d-8122-e06e4bb7d40c.png">
</a> </a>
<br /> <br />
<a href="https://f-droid.org/packages/oss.krtirtho.spotube"> <a href="https://f-droid.org/packages/oss.krtirtho.spotube">
<img width="220" alt="Download from F-Droid" src="https://user-images.githubusercontent.com/61944859/174589876-bace24c0-b3fd-4c4a-bdb4-6fa82b5853ec.png"> <img width="220" alt="Download from F-Droid"
src="https://user-images.githubusercontent.com/61944859/174589876-bace24c0-b3fd-4c4a-bdb4-6fa82b5853ec.png">
</a> </a>
</td> </td>
</tr> </tr>
@ -91,24 +106,29 @@ This handy table lists all the methods you can use to install Spotube:
<td> <td>
<p><code>flatpak install com.github.KRTirtho.Spotube</code></p> <p><code>flatpak install com.github.KRTirtho.Spotube</code></p>
<a href="https://flathub.org/apps/details/com.github.KRTirtho.Spotube"> <a href="https://flathub.org/apps/details/com.github.KRTirtho.Spotube">
<img width="220" alt="Download on Flathub" src="https://flathub.org/assets/badges/flathub-badge-en.png"> <img width="220" alt="Download on Flathub"
src="https://flathub.org/assets/badges/flathub-badge-en.png">
</a> </a>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>AppImage</td> <td>AppImage</td>
<td> <td>
<a href="https://github.com/KRTirtho/spotube/releases/latest/download/Spotube-linux-x86_64.AppImage"> <a
<img width="220" alt="Download AppImage" src="https://user-images.githubusercontent.com/61944859/169455015-13385466-8901-48fe-ba90-b62d58b0be64.png"> href="https://github.com/KRTirtho/spotube/releases/latest/download/Spotube-linux-x86_64.AppImage">
<img width="220" alt="Download AppImage"
src="https://user-images.githubusercontent.com/61944859/169455015-13385466-8901-48fe-ba90-b62d58b0be64.png">
</a> </a>
<p><b>Note:</b> <a href="https://github.com/TheAssassin/AppImageLauncher">AppimageLauncher</a> is required!</p> <p><b>Note:</b> <a href="https://github.com/TheAssassin/AppImageLauncher">AppimageLauncher</a> is
required!</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>Debian/Ubuntu</td> <td>Debian/Ubuntu</td>
<td> <td>
<a href="https://github.com/KRTirtho/spotube/releases/latest/download/Spotube-linux-x86_64.deb"> <a href="https://github.com/KRTirtho/spotube/releases/latest/download/Spotube-linux-x86_64.deb">
<img width="220" alt="Debian/Ubuntu Download" src="https://user-images.githubusercontent.com/61944859/169097994-e92aff78-fd75-4c93-b6e4-f072a4b5a7ed.png"> <img width="220" alt="Debian/Ubuntu Download"
src="https://user-images.githubusercontent.com/61944859/169097994-e92aff78-fd75-4c93-b6e4-f072a4b5a7ed.png">
</a> </a>
<p>Then run: <code>sudo apt install ./Spotube-linux-x86_64.deb</code></p> <p>Then run: <code>sudo apt install ./Spotube-linux-x86_64.deb</code></p>
</td> </td>
@ -124,7 +144,8 @@ This handy table lists all the methods you can use to install Spotube:
<td>Fedora/OpenSuse</td> <td>Fedora/OpenSuse</td>
<td> <td>
<a href="https://github.com/KRTirtho/spotube/releases/latest/download/Spotube-linux-x86_64.rpm"> <a href="https://github.com/KRTirtho/spotube/releases/latest/download/Spotube-linux-x86_64.rpm">
<img width="220" alt="Fedora/OpenSuse Download" src="https://user-images.githubusercontent.com/61944859/223638350-5926b9da-04d6-4edd-931d-ad533e4ff058.png"> <img width="220" alt="Fedora/OpenSuse Download"
src="https://user-images.githubusercontent.com/61944859/223638350-5926b9da-04d6-4edd-931d-ad533e4ff058.png">
</a> </a>
<p>For Fedora: <code>sudo dnf install ./Spotube-linux-x86_64.rpm</code></p> <p>For Fedora: <code>sudo dnf install ./Spotube-linux-x86_64.rpm</code></p>
<p>For OpenSuse: <code>sudo zypper in ./Spotube-linux-x86_64.rpm</code></p> <p>For OpenSuse: <code>sudo zypper in ./Spotube-linux-x86_64.rpm</code></p>
@ -134,7 +155,8 @@ This handy table lists all the methods you can use to install Spotube:
<td>Linux (tarball)</td> <td>Linux (tarball)</td>
<td> <td>
<a href="https://github.com/KRTirtho/spotube/releases/latest"> <a href="https://github.com/KRTirtho/spotube/releases/latest">
<img width="220" alt="Tarball Download" src="https://user-images.githubusercontent.com/61944859/169456985-e0ba1fd4-10e8-4cc0-ab94-337acc6e0295.png"> <img width="220" alt="Tarball Download"
src="https://user-images.githubusercontent.com/61944859/169456985-e0ba1fd4-10e8-4cc0-ab94-337acc6e0295.png">
</a> </a>
</td> </td>
</tr> </tr>
@ -166,7 +188,20 @@ brew install --cask spotube
<p><code>winget install --id KRTirtho.Spotube</code></p> <p><code>winget install --id KRTirtho.Spotube</code></p>
</td> </td>
</tr> </tr>
<tr>
<td>IOS - <a
href="https://github.com/KRTirtho/spotube/releases/download/nightly/Spotube-iOS.ipa">IOS</a>
</td>
<td>
<p><code>IOS Install Spotube</code></p>
</td>
</tr>
</table> </table>
<div align="center">
<h4>© Copyright Spotube 2024</h4>
</div>
</div>
### 🔄 Nightly Builds ### 🔄 Nightly Builds
@ -318,5 +353,5 @@ If you are concerned, you can [read the reason of choosing this license](https:/
1. [draggable_scrollbar](https://github.com/fluttercommunity/flutter-draggable-scrollbar) - A scrollbar that can be dragged for quickly navigation through a vertical list. Additional option is showing label next to scrollthumb with information about current item. 1. [draggable_scrollbar](https://github.com/fluttercommunity/flutter-draggable-scrollbar) - A scrollbar that can be dragged for quickly navigation through a vertical list. Additional option is showing label next to scrollthumb with information about current item.
1. [dart_discord_rpc](https://github.com/alexmercerind/dart_discord_rpc) - Discord Rich Presence for Flutter & Dart apps & games. 1. [dart_discord_rpc](https://github.com/alexmercerind/dart_discord_rpc) - Discord Rich Presence for Flutter & Dart apps & games.
</details> </details>
</body>
<div align="center"><h4>© Copyright Spotube 2024</h4></div> </html>