30 lines
758 B
Markdown
30 lines
758 B
Markdown
# yellowcab
|
|
|
|
YellowCab is a web widget to tell someone what you're listening to at the very moment they load your page.
|
|
|
|
YellowCab currently supports these platforms:
|
|
|
|
- [Last.fm](https://www.last.fm/)
|
|
- [ListenBrainz](https://listenbrainz.org/)
|
|
- [Spotify](https://www.spotify.com/)
|
|
|
|
Feel free to suggest more!
|
|
|
|
## features
|
|
|
|
- Beautiful widget customizable to your liking
|
|
- JSON API to make your own widget
|
|
|
|
## roadmap
|
|
|
|
- JS autorefresh as an alternative to HTML autorefreshing
|
|
|
|
### [API Documentation](./docs/API.md)
|
|
|
|
### .env file requirements
|
|
|
|
- `LASTFM_KEY` - Last.fm API key
|
|
- `SPOTIFY_ID` - Spotify app ID
|
|
- `SPOTIFY_SECRET` - Spotify app secret
|
|
- `BASE_URL` - The root URL of the deployment, e.g. `https://yellowcab.example.com` (no trailing slash!)
|