Code Monkey home page Code Monkey logo

shields.io's Introduction

Shields Gittip

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

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/gittip/shields.io/master/static/[email protected]" 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.

shields.io's People

Contributors

olivierlacan avatar chadwhitacre avatar ackerdev avatar sferik avatar mmoreram avatar markoa avatar nickmerwin avatar laserlemon avatar

Watchers

Ori Pekelman avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.