suzanne.soy/shields
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Shields badge specification, website and default API server
924 Commits 8 Branches 0 Tags 4.4 MiB
JavaScript 78.5%
HTML 20.9%
Makefile 0.6%
43a6c5d049
Go to file
Thaddee Tyl 43a6c5d049 Gitter logo 
Meant to one day have the count of users in a room.

Uses the gitter logo, as discussed here:
https://twitter.com/alexindigo/status/638006616260894722.

Solves #440.
2015-11-21 11:41:20 +01:00
ass-stubs Fix tests to wait for server launch test stub to finish starting 2015-06-10 11:46:53 -06:00
logo Merge remote-tracking branch 'techtonik/master' 2015-09-02 19:38:16 +02:00
spec Fix Markdown formatting error 2015-04-16 22:43:15 +02:00
templates Fix corners in social-template 2015-08-18 02:27:45 +03:00
.buildpacks
.editorconfig .editorconfig file to help all contributers to align to a common project specific standards. 2015-11-05 20:32:40 +02:00
.gitignore ServerScript 2015-09-01 15:54:38 +02:00
.travis.yml make CI build faster 2014-08-18 02:22:18 +08:00
404.html Website: 404 page 2014-11-08 11:55:38 +01:00
badge.js Capitalize social badges 2015-06-20 15:51:56 +02: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 Add a link to C# port of Shield style badge lib. 2015-05-11 21:13:29 +02:00
coverage.svg New coverage badge 2015-06-06 11:43:59 +02:00
Dockerfile fix broken Dockerfile to use official node image instead 2015-09-21 09:52:18 -05:00
favicon.png Move website to the repo's root. 2014-02-14 16:54:09 +01:00
gh-badge.js bin: support json format 2014-10-25 19:16:35 +02:00
index.html website: imagelayers 2015-11-21 11:40:53 +01:00
INSTALL.md fix broken Dockerfile to use official node image instead 2015-09-21 09:52:18 -05: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 Remove dead make entries 2015-11-07 17:55:33 +01:00
package.json Use SPDX license, update redis library 2015-09-07 10:35:18 +02:00
phantomjs-svg2png.js Local font loading into SVG in Phantom.js 2014-01-05 22:02:02 +01:00
README.md HTTPS badges 2015-09-08 19:52:47 +02:00
server.js Gitter logo 2015-11-21 11:41:20 +01:00
suggest.js Suggest twitter badges 2015-07-26 18:57:45 +02:00
svg-to-img.js Separated the LRU cache implementation. 2014-04-27 23:47:12 +00:00
test.js Fix tests to wait for server launch test stub to finish starting 2015-06-10 11:46:53 -06:00
try.html Gitter logo 2015-11-21 11:41:20 +01:00

README.md

Gratipay npm version build status

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

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.