This is home to Shields.io, a service for concise, consistent, and legible badges in SVG and raster format, which can easily be included in GitHub readmes or any other web page. The service supports dozens of continuous integration services, package registries, distributions, app stores, social networks, code coverage services, and code analysis services. Every month it serves over 470 million images.
In addition to hosting the shields.io frontend and server code, this monorepo hosts an NPM library for generating badges, and the badge design specification.
- build status:
build | failing - code coverage percentage:
coverage | 80% - stable release version:
version | 1.2.3 - package manager release:
gem | 1.2.3 - status of third-party dependencies:
dependencies | out-of-date - static code analysis GPA:
code climate | 3.8 - SemVer version observance:
semver | 2.0.0 - amount of Gratipay donations per week:
tips | $2/week
Make your own badges!
(Quick example: https://img.shields.io/badge/left-right-f39f37.svg)
Browse a complete list of badges.
Shields is a community project. We invite your participation through issues and pull requests! You can peruse the contributing guidelines.
When adding or changing a service please add tests.
This project has quite a backlog of suggestions! If you're new to the project, maybe you'd like to open a pull request to address one of them:
You can read a tutorial on how to add a badge.
npm install -g gh-badges
badge build passed :green .png > mybadge.pngconst badge = require('gh-badges')
// Optional step, to have accurate text width computation.
const format = {
text: ['build', 'passed'],
colorscheme: 'green',
template: 'flat',
}
badge.loadFont('/path/to/Verdana.ttf', err => {
badge(format, (svg, err) => {
// svg is a string containing your badge
})})View the documentation for gh-badges.
Note: The badge library was last released in 2016.
- Install Node 8 or later. You can use the package manager of your choice. Tests need to pass in Node 8 and 9.
- Clone this repository.
- Run
npm installto install the dependencies. - Run
npm run buildto build the frontend. - Run
npm startto start the server. - Open
http://[::]:8080/to view the home page.
To generate the frontend using production cache settings – that is,
badge preview URIs with maxAge – run LONG_CACHE=true npm run build.
To analyze the frontend bundle, run npm install webpack-bundle-analyzer and
then ANALYZE=true npm start.
Snapshot tests ensure we don't inadvertently make changes that affect the
SVG or JSON output. When deliberately changing the output, run
SNAPSHOT_DRY=1 npm run test:js:server to preview changes to the saved
snapshots, and SNAPSHOT_UPDATE=1 npm run test:js:server to update them.
The server can be configured to use Sentry.
There is documentation about hosting your own server.
b.adge.me was the original website for this service. Heroku back then had a thing which made it hard to use a toplevel domain with it, hence the odd domain. It used code developed in 2013 from a library called gh-badges, both developed by Thaddée Tyl. The project merged with shields.io by making it use the b.adge.me code and closed b.adge.me.
The original badge specification was developed in 2013 by Olivier Lacan. It was inspired by the Travis CI and similar badges (there were a lot fewer, back then). In 2014 Thaddée Tyl redesigned it with help from a Travis CI employee and convinced everyone to switch to it. The old design is what today is called the plastic style; the new one is the flat style.
You can read more about the project's inception, the motivation of the SVG badge specification, and the specification itself.
espadrine is the sysadmin.
These contributors donate time on a consistent basis to help guide and maintain the project:
All assets and code are under the CC0 LICENSE and in the public domain unless specified otherwise.
The assets in logo/ are trademarks of their respective companies and are
under their terms and license.
This project exists thanks to all the people who contribute. [Contribute].
Thank you to all our backers! 🙏 [Become a backer]
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
