diff --git a/README.md b/README.md index 3b9a7e9..a9d2533 100644 --- a/README.md +++ b/README.md @@ -17,15 +17,34 @@ [^1]: We should note that NGINX doesn't guarantee such a consistency by default. To this end, you have to add `if` statement in the configuration file in NGINX. -## Making an executable binary +## Installing/Building an executable binary of `rpxy` + + +You can build an executable binary yourself by checking out this Git repository. + +```:bash +# Cloning the git repository +% git clone https://github.com/junkurihara/rust-rpxy +% cde rust-rpxy + +# Update submodule hyperium/h3 +% git submodule update --init + +# Build % cargo build --release ``` -Then you have a binary at `./target/release/rpxy`. - -You can also use [`docker` image](https://hub.docker.com/r/jqtype/rpxy) instead of building from the source. +Then you have an executive binary `rust-rpxy/target/release/rpxy`. ## Usage @@ -37,4 +56,7 @@ todo! ## Using `docker` image +You can also use [`docker` image](https://hub.docker.com/r/jqtype/rpxy) instead of directly executing the binary. + + todo! diff --git a/TODO.md b/TODO.md index b8d4087..907aba2 100644 --- a/TODO.md +++ b/TODO.md @@ -5,4 +5,5 @@ - Smaller footprint of docker image using musl - Refactoring - Options to serve custom http_error page. +- Prometheus metrics - etc.