Skip to content
A legible & concise status badge solution for third-party codebase services.
Pull request Compare This branch is 50 commits ahead, 1136 commits behind badges:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
code_climate
coveralls
font/Open_Sans
gemnasium
rubygems
travis
CONTRIBUTING.md
LICENSE.md
README.md
dribbble.png
proportions.png
shields.psd
shields.svg
shields@2x.psd
shields_black.png
shields_white.png
shields_white@2x.png

README.md

Shields

A legible & concise status badge solution for third-party codebase services. Soon to be Retina-ready.

shields on white

Services using Shields

Problem

An increasing number of 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.

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.

shields on white

shields on black

You can find a Photoshop CS6 PSD file containing the simple vector shapes and non-destructive styles I applied to create these.

Thanks to @ackerdev we also have SVG equivalents of all existing badges if you would like your badges to be Retina-ready or dynamically manipulate the text inside of them before you output them to PNG 24 Alpha (transparent background).

Retina Ready

Since one of the major concerns is legibility, it's impossible to ignore how bad shields will look on retina (high DPI) displays.

A suggested by @kneath, Shields displayed with an HTML image tag (instead of the easier Markdown image tag) can be given a fixed height to force an image that is actually double the resolution into a 50% smaller image, which will display properly for both retina and non-retina screens.

Here's an example with the following code:

<img src="https://raw.github.com/olivierlacan/shields/master/shields_white@2x.png" height="143" alt="Retina-ready Shields example" />

Retina-ready Shields example

All shields aren't yet compatible with this but we're working on updating them soon. Look for image filenames with @2x suffixes, those will be the pixel doubled versions.

Note: They were pixel doubled manually in Photoshop, not after the fact.

Font

The font used on these badges is the Apache licensed Open Sans Regular available from Google Web Fonts.

How to resize a Shield

Want to use one of these swanky badges for your own service right now and don't have time to open an issue and wait for us to help you out?

Well here's a hint, if you need to resize the badge yourself in Photoshop make sure you use the vector points like this.

In Illustrator, it's a little different (4.8 MB .mov video).

Contributions

See CONTRIBUTING.md.

License

See LICENSE.md.

Something went wrong with that request. Please try again.