diff --git a/static/index.html b/static/index.html new file mode 100644 index 0000000..8122170 --- /dev/null +++ b/static/index.html @@ -0,0 +1,74 @@ + + + + + Hits-of-Code Badges + + + +

Hits-of-Code Badges

+ +
+This API offers badges for the Hits-of-Code metric for your repositories. This metric was proposed by +Yegor Bugayenko as an +alternative to Lines-of-Code. +
+ +

+ +

+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. +
+ +

+ +

+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://hoc.oldsql.cc/<service>/<user>/<repo>)
+
+ + +where <service> is one of github, gitlab or bitbucket. So the +following Markdown + + +
+        ![Hits-of-Code](https://hoc.oldsql.cc/github/vbrandl/elm-chess)
+
+ + +would render this badge: + + +
+        
+
+ +
+ +

Source Code

+ +
+The whole service is licensed under the MIT license and the source +code can be found on GitHub. Feature proposals or pull requests are +welcome. +
+ +

Contact

+ +
+You can reach me via mail: mail+hoc@vbrandl.net preferably using +my GPG key +(from a + keyserver), or by using any other UID from my key. +
+ + +