<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="keywords" content="Hits-of-Code, GitHub, Badge" />
<meta name="description" content="Hits-of-Code Badges for Git repositories" />
<link rel="stylesheet" href="tacit-css.min.css" />
<title>Hits-of-Code Badges</title>
</head>
<body>
<section>
<header>
<h1>Hits-of-Code Badges</h1>
</header>
<article>
<p>
This API offers badges for the Hits-of-Code metric for your repositories. This metric was proposed by
<a href="https://www.yegor256.com/">Yegor Bugayenko</a> as an
<a href="https://www.yegor256.com/2014/11/14/hits-of-code.html">alternative to Lines-of-Code</a>.
</p>
<p>
Instead of counting the number of existing lines in a codebase, the number of modified lines is counted. That way, the
metric can only grow and never shrink. While this metric still cannot give any information about the code quality, it
gives an overview about the amount of work put into a codebase.
</p>
<p>
There is a <a href="https://github.com/yegor256/hoc/">command-line tool</a> 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:
</p>
<pre>
[](https://hitsofcode.com/view/<service>/<user>/<repo>)
</pre>
<p>
where <code><service></code> is one of <code>github</code>, <code>gitlab</code> or <code>bitbucket</code>. So the
following Markdown
</p>
<pre>
[](https://hitsofcode.com/view/github/vbrandl/hoc)
</pre>
<p>
would render this badge:
</p>
<pre>
<a href="https://hitsofcode.com/view/github/vbrandl/hoc"><img src="https://hitsofcode.com/github/vbrandl/hoc"
alt="example badge" /></a>
</pre>
<h2>Colors</h2>
<p>
You can generate badges with custom colors via the <code>color</code> query parameter. The following predefined colors
are supported:
</p>
<pre>
<img src="/badge?color=brightgreen" alt="brightgreen example badge" />
<img src="/badge?color=green" alt="green example badge" />
<img src="/badge?color=yellowgreen" alt="yellowgreen example badge" />
<img src="/badge?color=yellow" alt="yellow example badge" />
<img src="/badge?color=orange" alt="orange example badge" />
<img src="/badge?color=red" alt="red example badge" />
<img src="/badge?color=blue" alt="blue example badge" />
<img src="/badge?color=lightgrey" alt="lightgrey example badge" />
<img src="/badge?color=success" alt="success example badge" />
<img src="/badge?color=important" alt="important example badge" />
<img src="/badge?color=critical" alt="critical example badge" />
<img src="/badge?color=informational" alt="informational example badge" />
<img src="/badge?color=inactive" alt="inactive example badge" />
</pre>
<p>
You can also pass HTML color codes:
</p>
<pre>
<img src="/badge?color=ff69b4" alt="long HTML color code example badge" /> <img src="/badge?color=9cf" alt="short HTML
color code example badge" />
</pre>
<h2>Source Code</h2>
<p>
The whole service is licensed under the <a href="https://opensource.org/licenses/MIT">MIT license</a> and the source
code <a href="https://github.com/vbrandl/hoc">can be found on GitHub</a>. Feature proposals or pull requests are
welcome.
</p>
<h2>Contact</h2>
<p>
You can reach me via mail: <a href="mailto:mail+hoc@vbrandl.net">mail+hoc@vbrandl.net</a> preferably using
my <a href="https://mirror.oldsql.cc/key.asc">GPG key</a>
(<a href="http://pool.sks-keyservers.net/pks/lookup?op=get&search=0x1FFE431282F4B8CC0A7579167FB009175885FC76">from a
keyserver</a>), or by using any other UID from my key.
</p>
</article>
<footer>
<nav>
<ul>
<li>
<small>Created by <a href="https://www.vbrandl.net">Valentin Brandl</a>.</small>
</li>
</ul>
</nav>
<nav>
<ul>
<li><small><a href="https://github.com/vbrandl/hoc">GitHub</a></small></li>
<li><small><a href="https://opensource.org/licenses/MIT">MIT License</a></small></li>
</ul>
</nav>
</footer>
</section>
</body>
</html>