From cfd2425eb720839ed32be7fbfd0dde609ade1c40 Mon Sep 17 00:00:00 2001 From: Ville Vesilehto Date: Tue, 5 Nov 2024 21:43:14 +0200 Subject: [PATCH] update readme --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 43e9296..ee4d035 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,12 @@ $ cargo run -- --help Usage: single-page-web-server-rs [OPTIONS] Options: - --index-path Path to the index HTML file [env: WEB_INDEX_PATH=] [default: index.html] - --port Port to listen on [env: WEB_PORT=] [default: 3000] - --addr Address to bind to [env: WEB_ADDR=] [default: 127.0.0.1] - -h, --help Print help - -V, --version Print version + --index-path Path to the index HTML file [env: WEB_INDEX_PATH=] [default: index.html] + --port Port to listen on [env: WEB_PORT=] [default: 3000] + --addr Address to bind to [env: WEB_ADDR=] [default: 127.0.0.1] + --metrics-port Metrics server port [env: METRICS_PORT=] [default: 3001] + -h, --help Print help + -V, --version Print version ``` Examples: @@ -32,6 +33,12 @@ $ curl http://localhost:8080 foo ``` +Query metrics: + +```bash +$ curl http://localhost:3001/metrics +``` + ## Pre-built binaries Pre-built binaries are available in the [releases](https://github.com/thevilledev/single-page-web-server-rs/releases) page for the following platforms: