From 8ba4db40af8a2875b78a2ef8d6d96b258a3cb07f Mon Sep 17 00:00:00 2001 From: Sir RaptaG <77157639+RaptaG@users.noreply.github.com> Date: Mon, 15 May 2023 22:25:07 +0300 Subject: [PATCH] Initial README changes More to come --- README.md | 113 ++++++++++++++++++++---------------------------------- 1 file changed, 41 insertions(+), 72 deletions(-) diff --git a/README.md b/README.md index 14ac5697..3ccfbc70 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,19 @@ -

Spotube Logo

+
-

- spotube.netlify.app -

+Spotube Logo -

- - GitHub Workflow Status - - - GitHub release - - - License - - - Maintainer - - - Open Collective backers and sponsors - - - Discord - -

+Discord Server +GitHub Workflow Status +License +Support me on Patreon +Buy Me A Coffee -Spotube is a [Flutter](https://flutter.dev) based lightweight Spotify client. It utilizes the power of Spotify & Youtube's public APIs to create a reliable, robust & resource-light user experience. +Donate to our Open Collective + +
+ + -# Features +## Features Following are the features that currently Spotube offers: @@ -58,13 +41,7 @@ Following are the features that currently Spotube offers: - Time synced lyrics - Downloadable tracks -# Support development - - -[!["Donate to out Collective"](https://opencollective.com/spotube/donate/button.png?color=blue)](https://opencollective.com/spotube) -[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/krtirtho) - -# Installation +## Installation I'm always releasing newer versions of binaries of the software every 2-3 months with minor changes & every 6-8 months with major changes. Grab them! @@ -83,42 +60,45 @@ I'm always releasing newer versions of binaries of the software every 2-3 months | Windows (WinGet) | `winget install --id KRTirtho.Spotube` | | MacOS | [MacOS Download][mac-dlink] | -> **Note!:** If you don't understand this download table. You can read [installation instructions][wiki-installation-instructions] from the wiki +> If you don't understand this download table. You can read [installation instructions][wiki-installation-instructions] from the wiki -## Nightly Builds -Get the latest nightly builds of Spotube [here](https://github.com/KRTirtho/spotube/releases/tag/nightly). +### Nightly Builds -# TODO: -- [ ] Windows OS Media Control & Media Keys Support +Grab the latest nightly builds of Spotube [from the GitHub Releases](https://github.com/KRTirtho/spotube/releases/tag/nightly). + +## Roadmap + +- [X] Windows OS Media Control & Media Keys Support +- [X] Language Translations/Localization - [ ] Spotify Listen Along -- [x] Skip non-music sections from Audio Track -- [ ] Language Translations/Localization -# Building from source +## Building from source -You can find the details [here](CONTRIBUTION.md#your-first-code-contribution). +You can [read the instructions](CONTRIBUTION.md#your-first-code-contribution). -# Things that do not work + -[BSD-4-Clause](/LICENSE) +## The team -But why? You can learn about it [here](https://dev.to/krtirtho/choosing-open-source-license-wisely-1m3p). +- [Kingkor Roy Tirtho](https://github.com/KRTirtho) - The Founder, Maintainer and Lead Developer +- [Owen Conor](https://github.com/owencz1998) - The Cool Discord Moderator +- [Piotr Rogowski](https://github.com/karniv00l) - The MacOS Developer +- [RaptaG](https://github.com/raptag) - The GitHub Moderator and Community Manager +- [Rusty Apple](https://github.com/RustyApple) - The Mysterious Unknown Guy -# Financial contributors -## Backers -![Backers](https://opencollective.com/spotube/backer.svg?button=false) -![Donors](https://opencollective.com/spotube/tiers/donor.svg?button=false) +## License -## Sponsors -

- Sponsor Spotube -

+Spotube is open source and licensed under the [BSD-4-Clause](/LICENSE) License. -# Library/Plugin/Framework Credits +If you are concerned, feel free to [read the reason of choosing this license.](https://dev.to/krtirtho/choosing-open-source-license-wisely-1m3p). + +## Library/Plugin/Framework Credits 1. [Flutter](https://flutter.dev/) - Flutter transforms the app development process. Build, test, and deploy beautiful mobile, web, desktop, and embedded apps from a single codebase 1. [Spotify API](https://developer.spotify.com/documentation/web-api/) - The Spotify Web API is a RESTful API that provides access to Spotify data @@ -201,19 +181,8 @@ But why? You can learn about it [here](https://dev.to/krtirtho/choosing-open-sou 1. [spotify](https://github.com/rinukkusu/spotify-dart) - An incomplete dart library for interfacing with the Spotify Web API. 1. [window_size](https://github.com/google/flutter-desktop-embedding.git) - Allows resizing and repositioning the window containing Flutter. -# The team -- [Kingkor Roy Tirtho](https://github.com/KRTirtho) - The Founder, Maintainer and Lead Developer -- [Owen Conor](https://github.com/owencz1998) - The Cool Discord Moderator -- [Piotr Rogowski](https://github.com/karniv00l) - The MacOS Developer -- [RaptaG](https://github.com/raptag) - The GitHub Moderator and Community Manager -- [Rusty Apple](https://github.com/RustyApple) - The Mysterious Unknown Guy - -# Social platforms - -Follow me on [Twitter](https://twitter.com/@krtirtho), or join our amazing [Discord](https://discord.gg/uJ94vxB6vg) server to always get newer updates about the application. - -

© 2023 Spotube

 +

© Copyright Spotube 2023

[win32-dlink]: https://github.com/KRTirtho/spotube/releases/latest/download/Spotube-windows-x86_64-setup.exe