This is the home of Shields.io, containing the badge design specification and API documentation for Badges as a Service. There is also a gh-pages branch containing the static web site at shields.io.
We invite participation through GitHub Issues, which we use much like a discussion forum. This repository should only contain non-implementation specific topics: specifications, design, and the web site.
Please see INSTALL.md for information on how to get started.
Note that the root gets redirected to http://shields.io.
For testing purposes, you can go to http://localhost/try.html.
You should modify that file. The "real" root, http://localhost/index.html,
gets generated from the try.html file.
Please report bugs and discuss implementation specific concerns (performance characteristics, etc.) in the repository for the respective implementation:
| website / AP | language | issues |
|---|---|---|
| img.shields.io * | JavaScript | shields |
| shielded | JavaScript | shielded |
| buckler.repl.ca | Go | buckler |
| old img.shields.io * | Python | img.shields.io-old |
* gh-badges (ex-b.adge.me) has been adopted as the primary implementation going forward
* img.shields.io is being disbanded and replaced with gh-badges
Please open an issue if you'd like to use Shields badges for a project that isn't yet supported.
Our long term goal is to transform Shields into a service with which widely compatible badges can be generated via a simple API call, any help with this would be much appreciated.