vbrandl/hoc
1
0
Fork 0
Code Issues 1 Pull Requests Actions Projects Releases Wiki Activity

Add readme

Browse Source
This commit is contained in:
Valentin Brandl 2019-04-16 16:57:33 +02:00
parent 64ac7de831
commit 27f591f9e4
No known key found for this signature in database
GPG Key ID: 30D341DD34118D7D
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md Normal file
View File

@ -0,0 +1,22 @@
# Hits-of-Code
Small webservice, that returns a badge of the Hits-of-Code of a git repository,
as described by [Yegor
Bugayenko](https://www.yegor256.com/2014/11/14/hits-of-code.html). Currently
only GitHub repositories are supported, but it can be trivially extended to
support other platforms such as GitLab or Bitbucket.
## API
The API is as simple as
```
https://<host>/github/<user>/<repo>
```
## TODO
* Customization of badges (e.g. colors)
* Support other platforms beside GitHub
* Allow exclusion of certain files/globs from the HoC count