suzanne.soy/shields
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Minor cleanup and styling

Browse Source 
1. Rasterized and lined up the Shields logo to leading badges and subtitle;
2. Alphabetized the user list;
3. Verified the official project names:
 * Scrutinizer, minus CI
 * Version Badge vs Gemfury/RubyGems
 * Badger vs BadgerBadgerBadger
 * SemVer vs semver
 * Gratipay vs gratipay
4. Bunched the documentation links into a list.
This commit is contained in:
Bracconiere 2015-06-25 20:09:53 +03:00 committed by Thaddee Tyl
parent f204d4a21e
commit 1b72c86396
1 changed files with 58 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

110
README.md
View File

@ -1,43 +1,53 @@
# Shields [![Gratipay](http://img.shields.io/gratipay/shields.svg)](https://www.gratipay.com/Shields/) [![npm version](http://img.shields.io/npm/v/gh-badges.svg)](https://npmjs.org/package/gh-badges) [![build status](http://img.shields.io/travis/badges/shields.svg)](https://travis-ci.org/badges/shields) [![Dependency Status](https://david-dm.org/badges/shields.svg)](https://david-dm.org/badges/shields)
<p align="center">
<img src="https://raw.githubusercontent.com/Tourorist/TPS/0f34e1e99bcb7689885c4868169f70afcefd5ffc/misc/shields-logo.png"
height="130">
</p>
<p align="center">
<a href="https://www.gratipay.com/Shields/">
<img src="http://img.shields.io/gratipay/shields.svg"
alt="Gratipay">
</a>
<a href="https://npmjs.org/package/gh-badges">
<img src="http://img.shields.io/npm/v/gh-badges.svg"
alt="npm version">
</a>
<a href="https://travis-ci.org/badges/shields">
<img src="http://img.shields.io/travis/badges/shields.svg"
alt="build status">
</a>
<a href="https://david-dm.org/badges/shields">
<img src="https://david-dm.org/badges/shields.svg"
alt="dependency status">
</a>
</p>
<p align="center"><sup><strong>An image server for legible and concise information. Our <a href="http://shields.io/">Homepage</a> | <a href="https://twitter.com/shields_io">Twitter</a></strong></sup></p>
An image server for legible & concise information.
* **[INSTALL.md](INSTALL.md)** – installation instructions.
* **[CONTRIBUTING.md](CONTRIBUTING.md)** – project contribution guidelines.
* **[SPECIFICATION.md](spec/SPECIFICATION.md)** – spec for the visual design of Shields badges.
* **[LICENSE.md](LICENSE.md)** – public domain dedication.
<http://shields.io>
**Installation Instructions**:
[INSTALL.md](INSTALL.md).
**Contributions**:
[CONTRIBUTING.md](CONTRIBUTING.md).
**Specification**:
[SPECIFICATION.md](spec/SPECIFICATION.md).
**License**:
[LICENSE.md](LICENSE.md).
## Problem
Many GitHub repos sport badges for things like:
- [Travis CI](https://travis-ci.org/) build status:
## Solving the problem
Many GitHub repositories sport badges for things like:
* [Travis CI](https://travis-ci.org/) build status:
![travis badge](http://f.cl.ly/items/2H233M0I0T43313c3h0C/Screen%20Shot%202013-01-30%20at%202.45.30%20AM.png)
- [Gemnasium](https://gemnasium.com/) dependency checks:
* [Gemnasium](https://gemnasium.com/) dependency checks:
![gemnasium badge](http://f.cl.ly/items/2j1D2R0q2C3s1x2y3k09/Screen%20Shot%202013-01-30%20at%202.46.10%20AM.png)
- [Code Climate](http://codeclimate.com):
* [Code Climate](http://codeclimate.com):
![code climate badge](http://f.cl.ly/items/0H2O1A3q2b3j1D2i0M3j/Screen%20Shot%202013-01-30%20at%202.46.47%20AM.png)
- [RubyGems](http://rubygems.org) released gem version:
* [RubyGems](http://rubygems.org) released gem version:
![rubygems badge](http://f.cl.ly/items/443X21151h1V301s2s3a/Screen%20Shot%202013-01-30%20at%202.47.10%20AM.png)
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.
## Solution
## 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](spec/proportions.png)
@ -45,39 +55,35 @@ As you can see below, without increasing the footprint of these badges, I've tri
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](http://shields.io).
## 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](http://semver.org/) version observance: `semver | 2.0.0`
- amount of [gratipay](http://gratipay.com) donations per week: `tips | $2/week`
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](http://semver.org/) version observance: `semver | 2.0.0`
* amount of [Gratipay](http://gratipay.com) donations per week: `tips | $2/week`
## Services using the Shields standard
- [Travis CI](https://github.com/travis-ci/travis-ci/issues/630#issuecomment-38054967)
- [Code Climate](https://codeclimate.com/changelog/510d4fde56b102523a0004bf)
- [Coveralls](https://coveralls.io/r/kaize/nastachku)
- [Gemfury/RubyGems](http://badge.fury.io/)
- [Gemnasium](http://support.gemnasium.com/forums/236528-general/suggestions/5518400-use-svg-for-badges-so-they-still-look-sharp-on-r)
- [GoDoc](https://godoc.org/)
- [Scrutinizer CI](https://scrutinizer-ci.com/)
- [Semaphore](https://semaphoreapp.com)
- [VersionEye][]
- [Read the Docs](https://readthedocs.org/)
- [BadgerBadgerBadger][gem]
- [badges2svg][]
- [reposs][]
- [ruby-gem-downloads-badge][]
- [PHPPackages](https://phppackages.org)
* [Badger][gem]
* [badges2svg][]
* [Code Climate](https://codeclimate.com/changelog/510d4fde56b102523a0004bf)
* [Coveralls](https://coveralls.io/)
* [Gemnasium](http://support.gemnasium.com/forums/236528-general/suggestions/5518400-use-svg-for-badges-so-they-still-look-sharp-on-r)
* [GoDoc](https://godoc.org/)
* [PHPPackages](https://phppackages.org)
* [Read the Docs](https://readthedocs.org/)
* [reposs][]
* [ruby-gem-downloads-badge][]
* [Scrutinizer](https://scrutinizer-ci.com/)
* [Semaphore](https://semaphoreapp.com)
* [Travis CI](https://github.com/travis-ci/travis-ci/issues/630#issuecomment-38054967)
* [Version Badge](http://badge.fury.io/)
* [VersionEye]
[gem]: https://github.com/badges/badgerbadgerbadger
[badges2svg]: https://github.com/bfontaine/badges2svg
[reposs]: https://github.com/rexfinn/reposs
[VersionEye]: https://www.versioneye.com/
[ruby-gem-downloads-badge]: https://github.com/bogdanRada/ruby-gem-downloads-badge/