Update Readme

- added badge ;)
- fixed typo
- added information about cairo dependency
This commit is contained in:
Stefan Judis 2014-01-07 23:50:15 +01:00 committed by Thaddee Tyl
parent 9e5606b3aa
commit 41cb5e8f23

View File

@ -1,10 +1,12 @@
[![NPM version](http://b.adge.me/npm/v/gh-badges.svg)](https://npmjs.org/package/gh-badges)
# GitHub badges in SVG format
Make your own badges! <http://gh-badges.herokuapp.com>
# Contribute
If you want to add a badge, you only need to modify `badges.json`.
If you want to add a badge, you only need to modify `default-badges.json`.
The format is the following:
@ -36,6 +38,12 @@ 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](https://npmjs.org/package/canvas) *you need* to have **cairo** installed.
For more information check the [wiki](https://github.com/LearnBoost/node-canvas/wiki/_pages) of the canvas project with system-specific installation details.
# Making your Heroku badge server
Once you have installed the [Heroku Toolbelt](https://toolbelt.heroku.com/):