Shields badge specification, website and default API server
Go to file
2016-07-05 10:57:13 +02:00
lib Remove todo for GitHub auth documentation 2016-07-02 12:14:34 +02:00
logo Add bitHound integration. 2015-12-30 10:03:52 -06:00
spec Fix Markdown formatting error 2015-04-16 22:43:15 +02:00
templates Comments 2015-12-01 10:34:08 -08:00
test Put all test-related files in test/ 2016-06-14 08:26:57 +02:00
.buildpacks Node engine version information. Deployment files. 2014-01-03 19:25:49 +01:00
.editorconfig .editorconfig file to help all contributers to align to a common project specific standards. 2015-11-05 20:32:40 +02:00
.gitignore Hide GitHub user tokens 2016-06-15 23:57:59 +02:00
.travis.yml Upgrade to node 6 2016-06-12 15:00:29 +02:00
404.html Website: 404 page 2014-11-08 11:55:38 +01:00
badge.js Increase chances of pixel grid alignment 2016-03-13 23:55:06 +01:00
CNAME CNAME for shields.io 2014-02-24 11:53:27 +01:00
colorscheme.json move colorscheme back to original location, add @ syntax to cli for specifying style, cache templates on server start 2014-04-19 10:27:20 -07:00
CONTRIBUTING.md Document the command to generate index.html 2016-03-28 19:53:49 +02:00
coverage.svg New coverage badge 2015-06-06 11:43:59 +02:00
Dockerfile chore(docker): do not target a specific minor 2016-01-16 15:32:37 +01:00
favicon.png favicon.png recompress with zopflipng losslessly 2016-03-13 00:13:31 +08:00
gh-badge.js bin: support json format 2014-10-25 19:16:35 +02:00
index.html update keywords of GitHub issues integration 2016-07-03 20:31:30 +08:00
INSTALL.md Document the "template" option 2016-07-03 20:46:37 +02:00
LICENSE.md Files related to the switch to the shields repo. 2014-02-23 22:53:34 +01:00
load-logos.js GitHub logos for social badges 2015-05-31 13:24:04 +02:00
logo.svg Move website to the repo's root. 2014-02-14 16:54:09 +01:00
lru-cache.js Reduce cache size 2015-09-21 14:28:11 +02:00
Makefile website: detect query string when adding HTTP caching 2016-04-26 09:46:50 +02:00
measure-text.js Support fallback font when Verdana isn't available 2015-07-22 17:31:24 +01:00
package.json npm 1.2.2: another bugfix camp update 2016-06-26 16:20:42 +02:00
phantomjs-svg2png.js Local font loading into SVG in Phantom.js 2014-01-05 22:02:02 +01:00
README.md Merge remote-tracking branch 'g105b/master' into codacy 2016-05-16 23:59:20 +02:00
server.js GitHub stars and commits: metric figures 2016-07-05 10:57:13 +02:00
suggest.js Upgrade to node 6 2016-06-12 15:00:29 +02:00
svg-to-img.js Upgrade phantomjs 2016-05-05 20:08:21 +02:00
try.html Merge remote-tracking branch 'larsbrinkhoff/master' 2016-07-04 19:49:28 +02:00

Gratipay npm version build status

An image server for legible and concise information. Our Homepage | Twitter

Make your own badges here! (Quick guide: https://img.shields.io/badge/left-right-f39f37.svg.)

Solving the problem

Many GitHub repositories sport badges for things like:

Travis CI

(build status)

Travis CI badge
Gemnasium

(dependency checks)

Gemnasium badge
Code Climate

(static analysis)

Code Climate badge
RubyGems

(released gem version)

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.

The Shields 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

This badge design corresponds to an old and now deprecated version which has since been replaced by beautiful and scalable SVG versions that can be found on shields.io.

Examples

What kind of metadata 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 Gratipay donations per week: tips | $2/week

Services using the Shields standard

Legal

All assets and code are under the CC0 LICENSE and in the public domain unless specified otherwise.

The assets in logo/ are trademarks of their respective companies and are under their terms and license.