Permalink
Browse files

Files related to the switch to the shields repo.

  • Loading branch information...
espadrine committed Feb 23, 2014
1 parent 711009b commit 3f3f1b30bb8aade8ab6907fab3b7f889dfb3e882
Showing with 268 additions and 98 deletions.
  1. +44 −0 CONTRIBUTING.md
  2. +127 −0 INSTALL.md
  3. +33 −0 LICENSE.md
  4. +46 −98 README.md
  5. +18 −0 spec/SPECIFICATION.md
  6. BIN spec/proportions.png
View
@@ -0,0 +1,44 @@
+# Contribution Guidelines
+
+This is the home of Shields.io, containing the badge design specification and API documentation for Badges as a Service. There is also a [gh-pages branch][website] containing the static web site at [shields.io][].
+
+We invite participation through [GitHub Issues][], which we use much like a discussion forum. This repository should only contain non-implementation specific topics: specifications, design, and the web site.
+
+## Implementations
+
+Please report **bugs** and discuss implementation specific concerns (performance characteristics, etc.) in the repository for the respective implementation:
+
+| website / AP | language | issues |
+| ----------------------------- | ---------- | ----------------------------- |
+| [img.shields.io][] * | JavaScript | [shields][gh-badges issues] |
+| shielded | JavaScript | [shielded][shielded issues] |
+| [buckler.repl.ca][] | Go | [buckler][buckler issues] |
+| old img.shields.io * | Python | [img.shields.io-old][] |
+
+\* gh-badges (ex-`b.adge.me`) [has been adopted][primary] as the primary implementation going forward
+\* img.shields.io is being disbanded and replaced with gh-badges
+
+## Adding support for a service
+
+Please [open an issue][new issue] if you'd like to use Shields badges for a project that isn't yet supported.
+
+## Shields-as-a-Service
+
+Our long term goal is to transform Shields into a service with which widely compatible badges can be generated via a simple API call, any help with this would be much appreciated.
+
+[shields.io]: http://shields.io/
+[website]: https://github.com/badges/shields/tree/gh-pages
+[GitHub Issues]: https://github.com/badges/shields/issues
+[new issue]: https://github.com/badges/shields/issues/new
+
+[img.shields.io]: http://img.shields.io/
+[gh-badges issues]: https://github.com/badges/shields/issues
+[primary]: https://github.com/badges/shields/issues/94
+
+[shielded issues]: https://github.com/badges/shielded/issues
+
+[buckler.repl.ca]: http://buckler.repl.ca/
+[buckler issues]: https://github.com/badges/buckler/issues
+
+[img.shields.io-old]: https://github.com/badges/img.shields.io-old/issues
+
View
@@ -0,0 +1,127 @@
+# GitHub badges in SVG format
+
+[![npm version](http://img.shields.io/npm/v/gh-badges.svg)](https://npmjs.org/package/gh-badges)
+
+![coverage](https://rawgithub.com/badges/gh-badges/master/coverage.svg)
+
+[![build status](http://img.shields.io/travis/badges/gh-badges.svg)](https://travis-ci.org/badges/gh-badges)
+
+Make your own badges [here][badges]!
+
+[badges]: <http://img.shields.io>
+
+# Install the API
+
+```bash
+npm install gh-badges
+```
+
+```js
+var badge = require('gh-badges');
+badge({ text: [ "build", "passed" ], colorscheme: "green" },
+ function(svg) {
+ // svg is a String… of your badge.
+ });
+```
+
+# Use the CLI
+
+```bash
+npm install -g gh-badges
+badge build passed :green .png > mybadge.png
+# Stored a PNG version of your badge on disk.
+```
+
+# Set the Server
+
+```bash
+git clone git@github.com:badges/gh-badges
+cd gh-badges
+npm install
+sudo npm start
+```
+
+The root gets redirected to <http://shields.io>.
+For testing purposes, you can go to `http://localhost/try.html`.
+You should modify that file. The "real" root, `http://localhost/index.html`,
+gets generated from the `try.html` file.
+
+# Format
+
+The format is the following:
+
+```js
+{
+ /* Textual information shown, in order. */
+ "text": [ "build", "passed" ],
+ "colorscheme": "green"
+ /* … Or… */
+ "colorA": "#555",
+ "colorB": "#4c1"
+}
+```
+
+# Defaults
+
+If you want to add a default badge, you only need to modify
+`default-badges.json`. The format is the same as that given to the API.
+
+If you want to add a colorscheme, head to `colorscheme.json`. Each scheme has a
+name and a [CSS/SVG color][] for the color used in the first box (for the first
+piece of text, field `colorA`) and for the one used in the second box (field
+`colorB`).
+
+[CSS/SVG color]: http://www.w3.org/TR/SVG/types.html#DataTypeColor
+
+```js
+"green": {
+ "colorB": "#4c1"
+}
+```
+
+Both `colorA` and `colorB` have default values. Usually, the first box uses the
+same dark grey, so you can rely on that default value by not providing a
+`"colorA"` field (such as above).
+
+You can also use the `"colorA"` and `"colorB"` fields directly in the badges if
+you don't want to make a color scheme for it. In that case, remove the
+`"colorscheme"` field altogether.
+
+# Requirements
+
+Because of the usage of the npm module [canvas][canvas-pkg] *you need* to have
+**cairo** installed.
+
+For more information check the [wiki][canvas-wiki] of the canvas project with
+system-specific installation details.
+
+[canvas-pkg]: https://npmjs.org/package/canvas
+[canvas-wiki]: https://github.com/LearnBoost/node-canvas/wiki/_pages
+
+# Making your Heroku badge server
+
+Once you have installed the [Heroku Toolbelt][]:
+
+[Heroku Toolbelt]: https://toolbelt.heroku.com/
+
+```bash
+heroku login
+heroku create your-app-name
+heroku config:set BUILDPACK_URL=https://github.com/mojodna/heroku-buildpack-multi.git#build-env
+cp /path/to/Verdana.ttf .
+make deploy
+heroku open
+```
+
+# Links
+
+See <https://github.com/h5bp/lazyweb-requests/issues/150> for a story of the
+project's inception.
+
+This is also available as a gem `badgerbadgerbadger`, [code here][gem].
+
+[gem]: https://github.com/badges/badgerbadgerbadger
+
+# License
+
+All work here is licensed CC0.
View
@@ -0,0 +1,33 @@
+# DEDICATED TO THE PUBLIC DOMAIN
+
+Shields has been dedicated to the public domain. It is protected by the Creative Commons CC0 Universal Public Domain Dedication license. You can read the entire license below or at http://creativecommons.org/publicdomain/zero/1.0/deed.en.
+
+# CC0 UNIVERSAL PUBLIC DOMAIN DEDICATION LICENSE
+
+## Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights (defined below) upon the creator and subsequent owner(s) (each and all, an "owner") of an original work of authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for the purpose of contributing to a commons of creative, cultural and scientific works ("Commons") that the public can reliably and without fear of later claims of infringement build upon, modify, incorporate in other works, reuse and redistribute as freely as possible in any form whatsoever and for any purposes, including without limitation commercial purposes. These owners may contribute to the Commons to promote the ideal of a free culture and the further production of creative, cultural and scientific works, or to gain reputation or greater distribution for their Work in part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any expectation of additional consideration or compensation, the person associating CC0 with a Work (the "Affirmer"), to the extent that he or she is an owner of Copyright and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and publicly distribute the Work under its terms, with knowledge of his or her Copyright and Related Rights in the Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be protected by copyright and related or neighboring rights ("Copyright and Related Rights"). Copyright and Related Rights include, but are not limited to, the following:
+a. the right to reproduce, adapt, distribute, perform, display, communicate, and translate a Work;
+b. moral rights retained by the original author(s) and/or performer(s);
+c. publicity and privacy rights pertaining to a person's image or likeness depicted in a Work;
+rights protecting against unfair competition in regards to a Work, subject to the limitations in paragraph 4(a), below;
+d. rights protecting the extraction, dissemination, use and reuse of data in a Work;
+e. database rights (such as those arising under Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, and under any national implementation thereof, including any amended or successor version of such directive); and
+f. other similar, equivalent or corresponding rights throughout the world based on applicable law or treaty, and any national implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention of, applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and unconditionally waives, abandons, and surrenders all of Affirmer's Copyright and Related Rights and associated claims and causes of action, whether now known or unknown (including existing as well as future claims and causes of action), in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each member of the public at large and to the detriment of Affirmer's heirs and successors, fully intending that such Waiver shall not be subject to revocation, rescission, cancellation, termination, or any other legal or equitable action to disrupt the quiet enjoyment of the Work by the public as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason be judged legally invalid or ineffective under applicable law, then the Waiver shall be preserved to the maximum extent permitted taking into account Affirmer's express Statement of Purpose. In addition, to the extent the Waiver is so judged Affirmer hereby grants to each affected person a royalty-free, non transferable, non sublicensable, non exclusive, irrevocable and unconditional license to exercise Affirmer's Copyright and Related Rights in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "License"). The License shall be deemed effective as of the date CC0 was applied by Affirmer to the Work. Should any part of the License for any reason be judged legally invalid or ineffective under applicable law, such partial invalidity or ineffectiveness shall not invalidate the remainder of the License, and in such case Affirmer hereby affirms that he or she will not (i) exercise any of his or her remaining Copyright and Related Rights in the Work or (ii) assert any associated claims and causes of action with respect to the Work, in either case contrary to Affirmer's express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+a. No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, licensed or otherwise affected by this document.
+b. Affirmer offers the Work as-is and makes no representations or warranties of any kind concerning the Work, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non infringement, or the absence of latent or other defects, accuracy, or the present or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law.
+c. Affirmer disclaims responsibility for clearing rights of other persons that may apply to the Work or any use thereof, including without limitation any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims responsibility for obtaining any necessary consents, permissions or other rights required for any use of the Work.
+d. Affirmer understands and acknowledges that Creative Commons is not a party to this document and has no duty or obligation with respect to this CC0 or use of the Work.
View
144 README.md
@@ -1,127 +1,75 @@
-# GitHub badges in SVG format
+# Shields [![Gittip](http://img.shields.io/gittip/shields.io.png)](https://www.gittip.com/Shields.io/) [![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/gh-badges.svg)](https://travis-ci.org/badges/gh-badges)
-[![npm version](http://img.shields.io/npm/v/gh-badges.svg)](https://npmjs.org/package/gh-badges)
-
-![coverage](https://rawgithub.com/badges/gh-badges/master/coverage.svg)
-
-[![build status](http://img.shields.io/travis/badges/gh-badges.svg)](https://travis-ci.org/badges/gh-badges)
+A legible & concise status badge solution for third-party codebase services.
Make your own badges [here][badges]!
[badges]: <http://img.shields.io>
-# Install the API
-
-```bash
-npm install gh-badges
-```
-
-```js
-var badge = require('gh-badges');
-badge({ text: [ "build", "passed" ], colorscheme: "green" },
- function(svg) {
- // svg is a String… of your badge.
- });
-```
-
-# Use the CLI
-
-```bash
-npm install -g gh-badges
-badge build passed :green .png > mybadge.png
-# Stored a PNG version of your badge on disk.
-```
+## Services using the Shields standard
+- [Code Climate](https://codeclimate.com/changelog/510d4fde56b102523a0004bf)
+- [Coveralls](https://coveralls.io/r/kaize/nastachku)
+- [Gemfury/RubyGems](http://badge.fury.io/)
+- [Gemnasium](http://blog.tech-angels.com/post/43141047457/gemnasium-v3-aka-gemnasium)
+- [Travis CI](http://about.travis-ci.org/docs/user/status-images/)
+- [Scrutinizer CI](https://scrutinizer-ci.com/)
+- [Semaphore](https://semaphoreapp.com)
-# Set the Server
+## Problem
+Many GitHub repos sport badges for things like:
+- [Travis CI](https://travis-ci.org/) build status:
-```bash
-git clone git@github.com:badges/gh-badges
-cd gh-badges
-npm install
-sudo npm start
-```
+![travis badge](http://f.cl.ly/items/2H233M0I0T43313c3h0C/Screen%20Shot%202013-01-30%20at%202.45.30%20AM.png)
-The root gets redirected to <http://shields.io>.
-For testing purposes, you can go to `http://localhost/try.html`.
-You should modify that file. The "real" root, `http://localhost/index.html`,
-gets generated from the `try.html` file.
+- [Gemnasium](https://gemnasium.com/) dependency checks:
-# Format
+![gemnasium badge](http://f.cl.ly/items/2j1D2R0q2C3s1x2y3k09/Screen%20Shot%202013-01-30%20at%202.46.10%20AM.png)
-The format is the following:
+- [Code Climate](http://codeclimate.com):
-```js
-{
- /* Textual information shown, in order. */
- "text": [ "build", "passed" ],
- "colorscheme": "green"
- /* … Or… */
- "colorA": "#555",
- "colorB": "#4c1"
-}
-```
+![code climate badge](http://f.cl.ly/items/0H2O1A3q2b3j1D2i0M3j/Screen%20Shot%202013-01-30%20at%202.46.47%20AM.png)
-# Defaults
+- [RubyGems](http://rubygems.org) released gem version:
-If you want to add a default badge, you only need to modify
-`default-badges.json`. The format is the same as that given to the API.
+![rubygems badge](http://f.cl.ly/items/443X21151h1V301s2s3a/Screen%20Shot%202013-01-30%20at%202.47.10%20AM.png)
-If you want to add a colorscheme, head to `colorscheme.json`. Each scheme has a
-name and a [CSS/SVG color][] for the color used in the first box (for the first
-piece of text, field `colorA`) and for the one used in the second box (field
-`colorB`).
+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.
-[CSS/SVG color]: http://www.w3.org/TR/SVG/types.html#DataTypeColor
+## 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.
-```js
-"green": {
- "colorB": "#4c1"
-}
-```
+![Badge design](spec/proportions.png)
-Both `colorA` and `colorB` have default values. Usually, the first box uses the
-same dark grey, so you can rely on that default value by not providing a
-`"colorA"` field (such as above).
+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.
-You can also use the `"colorA"` and `"colorB"` fields directly in the badges if
-you don't want to make a color scheme for it. In that case, remove the
-`"colorscheme"` field altogether.
+## Examples
-# Requirements
+What kind of meta data can you convey using badges?
-Because of the usage of the npm module [canvas][canvas-pkg] *you need* to have
-**cairo** installed.
+- 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 [gittip](http://gittip.com) donations per week: `tips | $2/week`
-For more information check the [wiki][canvas-wiki] of the canvas project with
-system-specific installation details.
+## Font
+The font chosen in the specification is the Apache licensed Open Sans Regular available from [Google Web Fonts](http://www.google.com/webfonts/specimen/Open+Sans).
-[canvas-pkg]: https://npmjs.org/package/canvas
-[canvas-wiki]: https://github.com/LearnBoost/node-canvas/wiki/_pages
+## Specification
+See [SPECIFICATION.md](spec/SPECIFICATION.md).
-# Making your Heroku badge server
+## Installation Instructions
+See [INSTALL.md](INSTALL.md).
-Once you have installed the [Heroku Toolbelt][]:
+## Contributions
+See [CONTRIBUTING.md](CONTRIBUTING.md).
-[Heroku Toolbelt]: https://toolbelt.heroku.com/
-
-```bash
-heroku login
-heroku create your-app-name
-heroku config:set BUILDPACK_URL=https://github.com/mojodna/heroku-buildpack-multi.git#build-env
-cp /path/to/Verdana.ttf .
-make deploy
-heroku open
-```
-
-# Links
-
-See <https://github.com/h5bp/lazyweb-requests/issues/150> for a story of the
-project's inception.
-
-This is also available as a gem `badgerbadgerbadger`, [code here][gem].
+## License
+See [LICENSE.md](LICENSE.md).
[gem]: https://github.com/badges/badgerbadgerbadger
-# License
-
-All work here is licensed CC0.
Oops, something went wrong.

0 comments on commit 3f3f1b3

Please sign in to comment.