Skip to content

Commit

Permalink
docs: flesh out readme with project details (#85)
Browse files Browse the repository at this point in the history
  • Loading branch information
cdrani authored Aug 27, 2023
1 parent f680fe4 commit 3ac4321
Showing 1 changed file with 45 additions and 1 deletion.
46 changes: 45 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,54 @@
# Chorus - Spotify Enhancer

Enhance Spotify with controls to save favourite track section and auto-skip. Save sections can be used for infinite looping of a chorus, verse, etc. Snips can be shared with others. Auto-skip tracks in a playlists or albums and never hear them again. Additionally set global playback speed and per track speed! More features to come!

## **🎉 Chorus Features :tada:**

:star: Save your favourite section of a Spotify track or podcast episode. That section then will the only part played for that track or episode. This can be used to play (or replay) a favourite chorus, sample, or a verse infinitely (if looped).

Use the slider left and right thumbs to narrow down the section you want to save. This saved section will be the only part of the song played from now on.

Set left and right thumbs at 0 to skip a track completely, or better yet...

:star: Block a song from being played forever. In the artist, album, playlists, or queue pages, clicking the block icon will toggle the track's blocked/unblocked state. In the blocked state, that song will always be skipped from being played in an album, queue, and/or playlist. Blocking a song takes precedence over a saved snip.

:star: Toggling the entire extension on/off by clicking the extension icon in the toolbar. Toggle the extension off whenever you want to listen to Spotify without your snips, blocked songs, or custom playback speeds and pitch. Toggle it back on to enjoy the features. It would be a good idea to have the extension pinned for quick access and use of this feature.

:star: Generate a shareable link to your favourite snip for easy sharing. Currently only copied to clipboard, but upcoming features will allow social media sharing such as on twitter, IG, etc. Note that link will only work if opening on desktop browser and recipient has the extension installed.

## 📆 **Upcoming features** :calendar:

✂️ Multi-Snips. More snips in a track. For example, snips to only play a chorus and the second verse of a track.

💿 Discography. Keep track of your progress as you work through an artist's discography and resume where you left off.

📓 Review. View your favourite snips and blocked songs. Some filtering.

💃 Enjoy Spotify again... again. 💃

## :gear: **Releases** :gear:

Releases are automated based on semantic releases and tagged as such in the [Releases](https://github.com/cdrani/chorus/releases) page. Releases have the newest features, bug fixes, etc, but the Web Store version is most likely on a day or two behind due to Chrome's review cycle. If you want the latest and greatest, the download the `Chorus.zip` file from the newest release.



## :wave: **Closing Remarks** :wave:

Please give a :star: if you like and/or use this project. [Contributions](./contributing.md) are wholeheartedly welcome if they adhere to the [coc](./code_of_conduct.md)

For issues, questions, feature suggestions, etc please report it [here](https://github.com/cdrani/chorus/issues/new/choose).

[Kofi Page](https://ko-fi.com/cdrani) if you are inclined. No obligation - in fact I might take it as an offence. This project is about adding some missing features in Spotify that I deem might warrant the price hikes. Just giving it a :star: here and rating on the Web Store is sufficient for me to keep adding features, fixing bugs, and maintaining it. Thanks!


<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->


## Contributors
## 👷‍♀️ **Contributors** 👷‍♂️

:heart: Shout out and love for people helping and/or helped on this project. :heart:

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
Expand Down

0 comments on commit 3ac4321

Please sign in to comment.