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-18 01:59:42 +02:00
parent 09381ccbb1
commit f24b0e017e
No known key found for this signature in database
GPG Key ID: 30D341DD34118D7D
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -1,6 +1,7 @@
# Hits-of-Code
![Hits-of-Code](https://hitsofcode.com/github/vbrandl/hoc)
![[Docker build](https://img.shields.io/docker/cloud/build/vbrandl/hits-of-code.svg)](https://hub.docker.com/r/vbrandl/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
@ -19,6 +20,33 @@ https://<host>/<service>/<user>/<repo>
where `<service>` is one of `gitub`, `gitlab` or `bitbucket`.
## Building
The code can be built as a standalone binary, using `cargo` or as a Docker container. Run either
```
$ cargo build --release
```
or
```
$ docker build .
```
inside the repository.
## Running
Run either the binary produced by cargo, the Docker container you just built (using docker-compose) or pull the image
from [Docker Hub](https://hub.docker.com/r/vbrandl/hits-of-code)
```
$ docker run -it --rm vbrandl/hits-of-code --help
```
## TODO
* [ ] Customization of badges (e.g. colors)