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

Update readme

Browse Source
This commit is contained in:
Valentin Brandl 2019-04-16 20:00:03 +02:00
parent 5944681086
commit 3c7ea095e7
No known key found for this signature in database
GPG Key ID: 30D341DD34118D7D
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

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