Share the items you have recently added to your bandcamp collection on your GitHub readme. Inspired by similar projects, including GitHub Readme Stats and Spotify Recently Played README.
Add the below snippet to your GitHub's README.md
page to retreive the most recent items from your bandcamp collection. Make sure you update the username
query parameter to reflect your username on bandcamp.
[![Bandcamp collection](https://bandcamp-collection-readme.vercel.app/getCollection?username=Johoseph)](https://github.com/Johoseph/bandcamp-collection-readme)
The following request query parameters can be used to customise the bandcamp collection list that is retrieved, see the below sub-headings for further explanation:
theme
- "light" or "dark"items
- numberinclude_wishlist
- booleanone_collection_item
- boolean
Display your collection in dark mode by adding &theme=dark
to your request URL.
![Bandcamp collection](https://bandcamp-collection-readme.vercel.app/getCollection?username=Johoseph&theme=dark)
Retrieve a custom number of collection items by adding the items
parameter to your URL (defaults to 5
when not specified).
![Bandcamp collection](https://bandcamp-collection-readme.vercel.app/getCollection?username=Johoseph&items=1)
Show only the items you have purchased by adding &include_wishlist=false
to your request URL.
![Bandcamp collection](https://bandcamp-collection-readme.vercel.app/getCollection?username=Johoseph&include_wishlist=false)
By default, the collection list will include at least 1
purchased item (provided the account has at least one purchased item). This means that at times, the default display of the list may not represent your 'true' most-recent bandcamp additions (i.e. you have wishlisted x
items since you purchased your last item). If this behaviour is undesired, you can add &one_collection_item=false
to your request URL to override it.
![Bandcamp collection](https://bandcamp-collection-readme.vercel.app/getCollection?username=Johoseph&one_collection_item=false)
Bandcamp does not have a public developer API, so to enable this app your Bandcamp data has to be retrieved via a web-scrape. A usual scrape request can take anywhere from 2 to 5 seconds - this creates a problem for Github's anonymised URL engine Camo, which has a maximum request time of 4 seconds. What this means is that longer scrape requests will occassional timeout, resulting in a 504
error from Camo and no image returned.