diff --git a/README.md b/README.md index f7e1ef2..594ad92 100644 --- a/README.md +++ b/README.md @@ -15,14 +15,23 @@ Run commands on host machine via http request. ## Configurable options - Below are the environment variables which can be set to overwrite default values - - RUST_LOG: determine log level, Default is INFO. - - R_CMD_TIMEOUT: Time out value in sec, only numerics, example: 100 for 100sec timeout, Default is 50 - - RUN_IT_PORT: port number to listen on, Default is 48786 + - `RUST_LOG`: determine log level, Default is INFO. + - `R_CMD_TIMEOUT`: Time out value in sec, only numerics, example: 100 for 100sec timeout, Default is 50 + - `RUN_IT_PORT`: port number to listen on, Default is 48786 ## DEMO https://github.com/chandrakanthkannam/run-it/assets/49658217/c6e55c75-6eeb-4a94-9786-6dace5cf2404 +## How to + +### Build locally + +- To build locally it is required to have `rust` and `cargo` installed +- Clone the repo and run: `cargo build -r` +- This would leave a executable in `/target/release/run-it` path +- If above environment variables are set those values are used otherwise default values are used. + ## TODO - Valid unit tests