diff --git a/static/index.html b/static/index.html index e834e5f..d3cf4ed 100644 --- a/static/index.html +++ b/static/index.html @@ -32,56 +32,62 @@ gives an overview about the amount of work put into a codebase. There is a command-line tool to calculate the HoC of a repository, but some people might want a nice badge to put in their README, that's why I implemented this API. Currently the API can be used for GitHub, GitLab and Bitbucket repositories. Just put the following code in your README: +

 [![Hits-of-Code](https://hitsofcode.com/<service>/<user>/<repo>)](https://hitsofcode.com/view/<service>/<user>/<repo>)
 
+

where <service> is one of github, gitlab or bitbucket. So the following Markdown +

 [![Hits-of-Code](https://hitsofcode.com/github/vbrandl/hoc)](https://hitsofcode.com/view/github/vbrandl/hoc)
 
+

would render this badge: +

-
+
 
-

Colors

You can generate badges with custom colors via the color query parameter. The following predefined colors are supported: +

-
-
-
-
-
-
-
-
+brightgreen example badge
+green example badge
+yellowgreen example badge
+yellow example badge
+orange example badge
+red example badge
+blue example badge
+lightgrey example badge
 
-
-
-
-
-
+success example badge
+important example badge
+critical example badge
+informational example badge
+inactive example badge
 
-

You can also pass HTML color codes: +

- 
+long HTML color code example badge short HTML
+color code example badge
 
-

Source Code