Update documentation #1129
Update documentation #1129
Conversation
CONTRIBUTING.md
Outdated
|
|
||
| [INSTALL.md]: ./INSTALL.md | ||
| This project has quite a backlog of suggestions! If you're new to the project, | ||
| maybe you'd like to opan a pull request to address one of them: |
There was a problem hiding this comment.
Did you mead open (instead of opan)?
CONTRIBUTING.md
Outdated
| `/VENDOR/SUBVENDOR-BADGE-SPECIFIC/PARAMETERS.format`. For instance, | ||
| `https://img.shields.io/gitter/room/nwjs/nw.js.svg`. The vendor is gitter, the | ||
| badge is for rooms, the parameter is nwjs/nw.js, and the format is svg. | ||
| []() |
There was a problem hiding this comment.
This could link to https://github.com/badges/shields/pulls?q=is%3Apr+is%3Aopen+label%3Abeginner-friendly. What do you think this about it?
CONTRIBUTING.md
Outdated
|
|
||
| Note that the root gets redirected to <http://shields.io>. | ||
| For testing purposes, you can go to `http://localhost/try.html`. | ||
| []() |
There was a problem hiding this comment.
This could link to https://github.com/badges/shields/issues?q=is%3Aissue+is%3Aopen+label%3Abeginner-friendly. What do you think about it?
There was a problem hiding this comment.
Great idea! Updated.
|
I've been putting off making more documentation changes while all the docs are in flight. It's time to get this merged. Thank you @platan for reading it. I'm hoping other people will read and continue to improve it. The project predates my involvement, so in particular, I want to get the history right! |
|
|
||
| The badge specification was developed in 2013 by [espadrine][] as part of a | ||
| library called [gh-badges][old-gh-badges], which then merged with shields.io, | ||
| badgr.co, and b.adge.me to form this project. You can read more about |
There was a problem hiding this comment.
b.adge.me was actually the original website for the service. (Heroku back then had a thing which made it hard to use a toplevel domain with it.) It used the https://github.com/badges/gh-badges code. We merged with shields.io by making it use the b.adge.me code and closed b.adge.me.
The original spec was by Olivier Lacan. It was inspired by the Travis CI and similar badges (there were a lot fewer, back then).
I redesigned the badge in 2014 with the help from a Travis CI employee and convinced everyone to switch to it (the old design is the plastic style; the new one is the flat style).
Based on info in #1129 (comment)
I wrote a new readme and contributing guidelines, and took a rough pass through the rest of the documentation.