Spotify ReadMe.md

A dynamic, customizable, and real-time Spotify now-playing widget for your README files. If you're not currently playing a song, it'll display one of your recent songs! It's width is sized like other common README widgets, so can be uniformly paired (see it in action on my own README). Feel free to ask for help or make any PRs 😄

Customization Previews

Just add query parameters to the endpoint, there are many possible combinations! (If you're on mobile and your screen is small, please use a desktop browser or change the zoom level to zoom out)

Parameter	Default	Values
spin	false	false, true
scan	false	false, true
theme	light	light, dark
rainbow	false	false, true

Default

/api

Spinning CD Effect

/api?spin=true

Include Scan Code

/api?scan=true

Rainbow Equalizer

/api?rainbow=true

Dark Theme

/api?theme=dark

Notes

This wasn't a completely original idea. This is my own version of novatorem's project that was supposed to be for me only, but others have asked for the source code so I made this repo. I also incorporated the latest two PR's from the orignal project into this one and made it easy to customize. I also excluded the Hide the EQ bar and Status String customizations (sorry).

Setup

The setup is slightly different from the original. Please refer to this page for the setup, but take notice of these differences:

• Use the /api endpoint as opposed to /api/spotify
• The environment variables are different:
  • SPOTIFY_CLIENT_ID ➠ CLIENT_ID
  • SPOTIFY_SECRET_ID ➠ CLIENT_SECRET
  • SPOTIFY_REFRESH_TOKEN ➠ REFRESH_TOKEN