diff --git a/README.md b/README.md index 85ecb9f..3914503 100644 --- a/README.md +++ b/README.md @@ -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:///// where `` 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)