# Awesome Badges

[![Awesome](https://awesome.re/badge.svg)](https://awesome.re)

A curated collection of awesome things related to status badges.

_While this list is maintained by Paul Melnikow from the Shields core team, it
includes Shields-related and non-Shields-related resources._

### Dynamic badge services

- [Shields.io](https://shields.io/) – Original home of the badges,
  launched in 2014.
- [Badgen.net](https://badgen.net/) – Fast badge generating service launched
  in 2018.
- [NodeICO](https://nodei.co/) – Large-format status badges for Node.js
  projects – which were once very popular!

### Raster badges

> SVG badges are encouraged because they render better on Retina displays and
> scale up beautifully. However in a few environments, such as Slack and HTML
> email, SVG images won't render, so PNG badges are preferred. Shields offers
> raster badges through its raster server, `raster.shields.io`.

- [svg-to-image-proxy](https://github.com/badges/svg-to-image-proxy) –
  Rasterizing proxy based on Node and Puppeteer which can be hosted on Vercel.
  (Since 2019 this code has been used to run `raster.shields.io`, however it's
  about to be deprecated in favor of [squint](https://github.com/badges/squint/).)
- [squint](https://github.com/badges/squint/) – Rasterizing proxy based on
  Rust and [libcairo](https://www.cairographics.org/).

### Static badges

- [For The Badge](https://forthebadge.com/) – Provides static badges
  using a flat and boxy badge design which has become a classic. (This badge
  format is available as `?style=for-the-badge` on Shields.io.)

### Static badge collections

- [Badges 4 README.md Profile](https://github.com/alexandresanlim/Badges4-README.md-Profile) – Catalog of Shields.io Badges for readme profiles
- [Project Types](https://project-types.github.io/) – Static badges for
  four types of open-source project, as classified in Nadia Eghbal's
  _Working in Public_.
- [Simple Badges](https://github.com/developStorm/simple-badges) – Catalog of Shields.io Badges with Simple Icons

### Dynamic data providers

> Dynamic data providers are third parties who publish data APIs which can be
> used to back one of the dynamic badge services:
>
> - [Shields' Endpoint badge](https://shields.io/endpoint)
> - [Badgen's https badge](https://badgen.net/https)
> - [Badgen's RunKit endpoint badge](https://badgen.net/runkit)

- [Transifex open API endpoints](https://transifex-open-api.herokuapp.com/)
  – Data gateway for projects using
  [Transifex](https://www.transifex.com/).
- [Cell Shield](https://cellshield.info) – a service that allows backing a shields.io badge with a cell from a public Google Spreadsheet.  
  
### Badge-rendering software

- [badge-maker](https://github.com/badges/shields/tree/master/badge-maker)
  – JavaScript; supports plastic, flat, flat-square, for-the-badge, and
  social styles. Powers Shields.io.
- [badgen](https://github.com/badgen/badgen) – TypeScript; supports classic
  and flat. Powers Badgen.
- [gradient-badge](https://github.com/bokub/gradient-badge) – JavaScript;
  generates gradient badges in classic and flat.
- [poser](https://github.com/badges/poser) – PHP.
- [pybadges](https://github.com/google/pybadges) – Python.
- [browser-support-badge](https://github.com/hustcc/browser-support-badge) –
  JavaScript; generates browser version compatibility badges.
- [badge4j](https://github.com/silentsoft/badge4j) – Java.

### Icons

- [Simple Icons](https://simpleicons.org/) – Home of the bulk of the
  icons used by both Shields and Badgen.

### Academic articles

- [Badges on npm packages](https://cmustrudel.github.io/projects/badges/)
  – Data-driven assessment based on signaling theory applied to how
  badges are used in npm.
  [Published in ICSE 2018](https://cmustrudel.github.io/papers/icse18badges.pdf).
- [On the Usage of Badges in Open Source Packages on GitHub](http://ceur-ws.org/Vol-2605/9.pdf)
  – Data-driven study of how status badges are used in Cargo and Packagist
  projects.

### Historical articles

- [An Open Source Rage Diamond](https://olivierlacan.com/posts/an-open-source-rage-diamond/)
  _(Jun. 5, 2014)_ – An article about the motivation for the Shields
  project by one of its creators.
- [Shields badge specification](https://github.com/badges/shields/blob/master/spec/SPECIFICATION.md)
  – Visual design specification for Shields.

### Talks

- [Shields.io by Nicco Kunzmann](https://www.youtube.com/watch?v=abBdk8bSPKU) –
  A talk given by Nicco Kunzmann for I Love Free Software Day in Berlin,
  Feb. 14, 2019.
- [Cool badges for your project by Marcin Mielnicki](https://raw.githubusercontent.com/hacktoberfest-poznan/presentations/master/2018/Cool-badges-for-your-project.pdf)
  ([photos](https://www.facebook.com/media/set/?vanity=hacktoberfest&set=a.258422348195183))
  – A talk given by Shields core team member Marcin Mielnicki for
  Hacktoberfest Poznań 2018.

### Hosting your own badge service

- [Shields self-hosting](https://github.com/badges/shields/blob/master/doc/self-hosting.md)
  – Host your own copy of Shields to Heroku, Vercel, using Docker, or on a Node server.
- [Badgen self-hosting](https://github.com/badgen/badgen.net/#environments) –
  Host your own copy of Badgen on Vercel.

### Achievement badges

- [Open Badges](https://openbadges.org/) – A specification for
  verifiable digital badges.
- [Badgr](https://www.badgr.org/) – A service for creating verifiable
  achievement badges, based on the Open Badges specification.