Shields badge specification, website and default API server

Go to file

Thaddee Tyl 1502080555 Code Climate coverage integration. Fixes #151.		2014-03-26 15:27:41 +01:00
ass-stubs	test: server PNG.	2014-01-19 13:32:43 +01:00
spec	Files related to the switch to the shields repo.	2014-02-23 22:53:34 +01:00
.buildpacks	Node engine version information. Deployment files.	2014-01-03 19:25:49 +01:00
.gitignore	Ignore project-specific files.	2014-02-27 10:26:51 +01:00
.travis.yml	Travis: install cairo.	2014-01-29 08:31:07 +01:00
badge.js	Using __dirname	2014-01-18 18:57:03 +01:00
CNAME	CNAME for shields.io	2014-02-24 11:53:27 +01:00
colorscheme.json	Better orange.	2014-01-06 15:28:05 +01:00
CONTRIBUTING.md	Mention that contributors should modify `try.html`.	2014-02-26 10:58:06 +01:00
coverage.svg	test: server PNG.	2014-01-19 13:32:43 +01:00
favicon.png	Move website to the repo's root.	2014-02-14 16:54:09 +01:00
gh-badge.js	cli: shebang.	2014-01-19 12:45:17 +01:00
index.html	Index building.	2014-03-17 13:57:27 +01:00
INSTALL.md	Explain how to use alternate ports in INSTALL.md	2014-03-23 11:12:29 -05:00
LICENSE	License file.	2014-02-01 10:16:22 +01:00
LICENSE.md	Files related to the switch to the shields repo.	2014-02-23 22:53:34 +01:00
logo.svg	Move website to the repo's root.	2014-02-14 16:54:09 +01:00
Makefile	[deploy] force add the font file.	2014-03-04 13:57:43 +01:00
package.json	Using Request for gittip vendor.	2014-03-03 02:41:05 +01:00
phantomjs-svg2png.js	Local font loading into SVG in Phantom.js	2014-01-05 22:02:02 +01:00
README.md	Mention Travis and Gemnasium support.	2014-03-20 02:13:27 +01:00
server.js	Code Climate coverage integration.	2014-03-26 15:27:41 +01:00
svg-to-img.js	website: favicon.	2014-01-17 15:31:29 +01:00
template.svg	Font size increase.	2014-01-14 11:37:40 +01:00
test.js	Fix writing the coverage page.	2014-02-14 18:02:26 +01:00
try.html	[website] fixed contributor name.	2014-03-15 12:36:03 +01:00

README.md

Shields

A legible & concise status badge solution for third-party codebase services.

Make your own badges here!

Services using the Shields standard

Problem

Many 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. 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 å 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.

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

Font

The font chosen in the specification is the Apache licensed Open Sans Regular available from Google Web Fonts.

Specification

See SPECIFICATION.md.

Installation Instructions

See INSTALL.md.

Contributions

See CONTRIBUTING.md.

License

See LICENSE.md.