2019-04-16 16:57:33 +02:00
|
|
|
# Hits-of-Code
|
|
|
|
|
|
2019-04-18 01:46:08 +02:00
|
|
|
|
|
|
|
|
|
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
|
|
|
|
2019-04-18 00:55:21 +02:00
|
|
|
A live version of this API can be found on [hitsofcode.com](https://hitsofcode.com/).
|
2019-04-16 20:02:21 +02:00
|
|
|
|
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:31:12 +02:00
|
|
|
where `<service>` is one of `gitub`, `gitlab` or `bitbucket`.
|
2019-04-16 20:00:03 +02:00
|
|
|
|
2019-04-16 16:57:33 +02:00
|
|
|
|
|
|
|
|
## TODO
|
|
|
|
|
|
2019-04-16 20:00:03 +02:00
|
|
|
* [ ] Customization of badges (e.g. colors)
|
2019-04-16 20:00:53 +02:00
|
|
|
* [x] Support other platforms beside GitHub (GitLab and Bitbucket)
|
2019-04-16 20:00:03 +02:00
|
|
|
* [ ] Allow exclusion of certain files/globs from the HoC count
|
2019-04-16 20:37:13 +02:00
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
`hoc` is licensed under the MIT License ([LICENSE](LICENSE) or http://opensource.org/licenses/MIT)
|
