rafaelwi / github-readme-lastfm-stats

Dynamically generated Last.fm stats for your profile readme

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

GitHub Readme Last.fm Stats

Dynamically generated last.fm stats in your profile readme

Netlify Status


Contents


Usage

To embed in your readme:

![alt text](https://github-readme-lastfm-stats.netlify.app/.netlify/functions/card?user=USERNAME&OPTIONS)

or

<img src="https://github-readme-lastfm-stats.netlify.app/.netlify/functions/card?user=USERNAME&OPTIONS"

The latter will allow you to better format the card (ex. align="center")


Options

Option Example Description
user user=st-silver (required) The user to fetch info for
theme theme=light (default)
theme=dimmed
theme=dark
(optional) The theme of the card. See the demo below to see how they look
show_scrobbles show_scrobbles=false (default)
show_scrobbles=true
(optional) Selects whether or not to show scrobble count

Demo

https://github-readme-lastfm-stats.netlify.app/.netlify/functions/card?user=st-silver

card/light-noScrobbles.svg


https://github-readme-lastfm-stats.netlify.app/.netlify/functions/card?user=st-silver&theme=dimmed

card/dimmed-noScrobbles.svg


https://github-readme-lastfm-stats.netlify.app/.netlify/functions/card?user=st-silver&theme=dark

card/dark-noScrobbles.svg


https://github-readme-lastfm-stats.netlify.app/.netlify/functions/card?user=st-silver&show_scrobbles=true

card/light-scrobbles.svg


https://github-readme-lastfm-stats.netlify.app/.netlify/functions/card?user=st-silver&theme=dimmed&show_scrobbles=true

card/dimmed-scrobbles.svg


https://github-readme-lastfm-stats.netlify.app/.netlify/functions/card?user=st-silver&theme=dark&show_scrobbles=true

card/dark-scrobbles.svg


Development & Deployment

Developing and deploying this project requires setting an environment variable that holds your last.fm API key. See here to find out how to get an API account.

export LASTFM_STATS_KEY=your_key_here

This also needs to be done on your deployment platform of choice. For Netlify, this can be done under Site Settings > Build & deploy > Environment.


Issues, Requests, and Contributing

Found an issue or have a feature request? Create a new one here and I will take a look at it ASAP. Please give as much detail as possible in your commment.

Like the project and want to lend a hand? Just make a pull request and I'll take a look.

About

Dynamically generated Last.fm stats for your profile readme

License:MIT License


Languages

Language:Go 97.4%Language:HTML 1.8%Language:Makefile 0.8%