hoc/README.md

23 lines
654 B
Markdown
Raw Normal View History

2019-04-16 16:57:33 +02:00
# Hits-of-Code
2019-04-16 20:00:03 +02:00
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.
2019-04-16 16:57:33 +02:00
## API
The API is as simple as
```
2019-04-16 20:00:03 +02:00
https://<host>/<service>/<user>/<repo>
2019-04-16 16:57:33 +02:00
```
2019-04-16 20:00:03 +02:00
where `<service` is one of `gitub`, `gitlab` or `bitbucket`.
2019-04-16 16:57:33 +02:00
## TODO
2019-04-16 20:00:03 +02:00
* [ ] Customization of badges (e.g. colors)
* [X] Support other platforms beside GitHub (GitLab and Bitbucket)
* [ ] Allow exclusion of certain files/globs from the HoC count