Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
thevilledev committed Nov 5, 2024
1 parent 0f78b54 commit cfd2425
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,12 @@ $ cargo run -- --help
Usage: single-page-web-server-rs [OPTIONS]

Options:
--index-path <INDEX_PATH> Path to the index HTML file [env: WEB_INDEX_PATH=] [default: index.html]
--port <PORT> Port to listen on [env: WEB_PORT=] [default: 3000]
--addr <ADDR> Address to bind to [env: WEB_ADDR=] [default: 127.0.0.1]
-h, --help Print help
-V, --version Print version
--index-path <INDEX_PATH> Path to the index HTML file [env: WEB_INDEX_PATH=] [default: index.html]
--port <PORT> Port to listen on [env: WEB_PORT=] [default: 3000]
--addr <ADDR> Address to bind to [env: WEB_ADDR=] [default: 127.0.0.1]
--metrics-port <METRICS_PORT> Metrics server port [env: METRICS_PORT=] [default: 3001]
-h, --help Print help
-V, --version Print version
```

Examples:
Expand All @@ -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:
Expand Down

0 comments on commit cfd2425

Please sign in to comment.