Shields badge specification, website and default API server
JavaScript Makefile
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 1339 commits behind badges:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
ass-stubs test: server PNG. Jan 19, 2014
spec Files related to the switch to the shields repo. Feb 23, 2014
templates Plastic style (instead of default) Nov 26, 2014
.buildpacks Node engine version information. Deployment files. Jan 3, 2014
.gitignore Hide the secret.json file. Jun 3, 2014
.travis.yml make CI build faster Aug 17, 2014
404.html Website: 404 page Nov 8, 2014
CNAME CNAME for shields.io Feb 24, 2014
CONTRIBUTING.md Mention that contributors should modify `try.html`. Feb 26, 2014
Dockerfile Dockerized the shields.io service Sep 28, 2014
INSTALL.md Coerce text to string. Nov 19, 2014
LICENSE.md Files related to the switch to the shields repo. Feb 23, 2014
Makefile Change ajax domain request. Jan 8, 2015
README.md add GoDoc to list of services using Shields Jan 3, 2015
badge.js Prevent possible invalid colors. Nov 19, 2014
colorscheme.json move colorscheme back to original location, add @ syntax to cli for s… Apr 19, 2014
coverage.svg Updated coverage badge Oct 27, 2014
favicon.png Move website to the repo's root. Feb 14, 2014
gh-badge.js bin: support json format Oct 25, 2014
index.html website update Jan 13, 2015
logo.svg Move website to the repo's root. Feb 14, 2014
lru-cache.js Default LRU cache size type is a unit Nov 20, 2014
package.json Use promises for suggestions Jan 18, 2015
phantomjs-svg2png.js Local font loading into SVG in Phantom.js Jan 5, 2014
server.js Support GitHub followers Jan 25, 2015
suggest.js Suggest github stars, forks, issues Jan 19, 2015
svg-to-img.js Separated the LRU cache implementation. Apr 27, 2014
test.js Fix test. Jul 28, 2014
try.html Support GitHub followers Jan 25, 2015

README.md

Shields Gittip npm version build status

An image server for legible & concise information.

http://shields.io

Installation Instructions: INSTALL.md.

Contributions: CONTRIBUTING.md.

Specification: SPECIFICATION.md.

License: LICENSE.md.

Problem

Many GitHub repos sport badges for things like:

travis badge

gemnasium badge

code climate badge

rubygems badge

As you can see from the zoomed 400% versions of these badges above, nobody is (really) using the same badge file and at normal size, they're hardly legible. Worst of all, they're completely inconsistent. The information provided isn't of the same kind on each badge. The context is blurry, which doesn't make for a straightforward understanding of how these badges are relevant to the project they're attached to and what information they provide.

Solution

As you can see below, without increasing the footprint of these badges, I've tried to increase legibility and coherence, removing useless text to decrease the horizontal length in the (likely) scenario that more of these badge thingies crop up on READMEs all across the land.

Badge design

We have an effort to produce similar-looking SVGs through a web service at http://img.shields.io. That ensures that we are retina-ready.

Examples

What kind of meta data can you convey using badges?

  • test 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 gittip donations per week: tips | $2/week

Services using the Shields standard