https://github.com/rafaelwi/github-readme-lastfm-stats

Dynamically generated Last.fm stats for your profile readme
https://github.com/rafaelwi/github-readme-lastfm-stats

dynamic last-fm lastfm profile-readme readme-generator readme-profile readme-stats serverless

Last synced: 5 months ago
JSON representation

Dynamically generated Last.fm stats for your profile readme

• Host: GitHub
• URL: https://github.com/rafaelwi/github-readme-lastfm-stats
• Owner: rafaelwi
• License: mit
• Created: 2021-05-03T20:17:13.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-05-06T05:22:03.000Z (over 4 years ago)
• Last Synced: 2025-04-01T03:51:21.596Z (6 months ago)
• Topics: dynamic, last-fm, lastfm, profile-readme, readme-generator, readme-profile, readme-stats, serverless
• Language: Go
• Homepage:
• Size: 226 KB
• Stars: 15
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# GitHub Readme Last.fm Stats

Dynamically generated last.fm stats in your profile readme

[![Netlify Status](https://api.netlify.com/api/v1/badges/f13a0213-6b93-4c0f-a3a3-5288199e9f42/deploy-status)](https://app.netlify.com/sites/github-readme-lastfm-stats/deploys)



## Contents

- [Usage](#usage)

- [Options](#options)

- [Demo](#demo)

- [Development & Deployment](#development--deployment)

- [Issues, Requests, and Contributing](#issues-requests-and-contributing)



## Usage

To embed in your readme:

```

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

```

or

```



## 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](./docs/card/light-noScrobbles.svg)


```

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

```

![card/dimmed-noScrobbles.svg](./docs/card/dimmed-noScrobbles.svg)


```

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

```

![card/dark-noScrobbles.svg](./docs/card/dark-noScrobbles.svg)


```

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

```

![card/light-scrobbles.svg](./docs/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](./docs/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](./docs/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.](https://www.last.fm/api#getting-started)

```

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](https://github.com/rafaelwi/github-readme-lastfm-stats/issues/new) 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.