From eb6848f8c96ed414e3c6d6147ab82493b7dbdad9 Mon Sep 17 00:00:00 2001 From: Thaddee Tyl Date: Thu, 2 Jan 2014 18:06:05 +0100 Subject: [PATCH] Some documentary information. --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index fc3b5b3..b5b5d05 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,26 @@ See . +# Contribute + +If you want to add a badge, only modify `badges.json`. + +The format is the following: + +```js +/* Unique name of your badge. */ +"build-passed": { + /* Textual information shown, in order. */ + "text": [ "build", "passed" ], + /* Width of the first box, width of the second box. */ + "widths": [ 33, 44 ], + /* Gradient of the background color of the second box. + * The main gradient is from index 1 to 2, + * indices 0 and 4 provide the light and dark outline. */ + "colorB": [ "#8f6", "#4c1", "#3b0", "#370" ] +} +``` + # License All work here is licensed CC0.