Shields

A coherent info-badge solution for codebases in either PNG or SVG formats.

Transparent PNG-24 and SVG versions for:

Travis CI
Gemnasium
Code Climate
RubyGems

Problem

An increasing number of GitHub repos sport badges for things like:

Travis CI build status:

Gemnasium dependency checks:

Code Climate:

RubyGems released gem version:

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.

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.

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" />

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

Please submit a pull request if you'd like to use Shields badges for a project that isn't yet supported, I'll gladly add them to the repository.

License

See the included file LICENSE.md.

License

lemurheavy/shields

ErrorLooks like something went wrong!

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Error
Looks like something went wrong!

Packages