This is home to [Shields.io][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 home page and server code, this monorepo hosts an [NPM library for generating badges][gh-badges], and the badge design specification.

Examples

• 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 guide: https://img.shields.io/badge/left-right-f39f37.svg.)

Browse a [complete list of badges][shields.io].

Contributing

Shields is a community project! We invite your participation through issues and pull requests.

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 opan a pull request to address one of them:

Or you can adopt one of these pull requests:

You can read a tutorial on how to add a badge.

You can peruse the contributing guidelines.

Using the badge library

npm install -g gh-badges
badge build passed :green .png > mybadge.png

const 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.

Development

1. Install Node 6 or later. You can use the package manager of your choice.
2. Clone this repository.
3. Run npm install to install the dependencies.
4. Run node server 1111 localhost to start the server.
5. Open http://localhost:1111/try.html to view the home page.

Hosting your own server

There is documentation about hosting your own server.

History

The badge specification was developed in 2013 by espadrine as part of a library called gh-badges, which then merged with shields.io, badgr.co, and b.adge.me to form this project. You can read more about the project's inception, the motivation of the SVG badge specification, and the specification itself.

Project leaders

espadrine is the sysadmin.

These contributors donate time on a consistent basis to help guide and maintain the project:

• Daniel15
• espadrine
• paulmelnikow

Related projects

• badgerbadgerbadger gem

License

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.