diff --git a/README.md b/README.md index 91b3b0e..e4f82a3 100644 --- a/README.md +++ b/README.md @@ -55,24 +55,28 @@ after it finishes. ## Usage -```text +```console +❯ httping --help +Ping an HTTP endpoint and report response latency + Usage: httping [OPTIONS] httping [OPTIONS] [URL] Commands: serve Show live probe statistics in a local web dashboard + help Print this message or the help of the given subcommand(s) Arguments: HTTP or HTTPS URL to probe Options: - -c, --count Number of probes to send. By default, probes continue until Ctrl-C - -i, --interval Minimum time between probe starts [default: 1s] - -t, --timeout Maximum time for DNS setup and for each probe [default: 10s] - --otlp Export OpenTelemetry metrics over OTLP HTTP/protobuf - --target-name Stable target name for exported metrics - -h, --help Print help - -V, --version Print version + -c, --count Number of probes to send. By default, probes continue until Ctrl-C + -i, --interval Minimum time between probe starts [default: 1s] + -t, --timeout Maximum time for DNS setup and for each probe [default: 10s] + --otlp Export OpenTelemetry metrics over OTLP HTTP/protobuf + --target-name Stable target name for exported metrics + -h, --help Print help + -V, --version Print version ``` Durations accept values such as `250ms`, `1s`, and `2m`. @@ -92,6 +96,8 @@ HTTPing selects a free local port and opens the dashboard in the default browser. The dashboard shows live summary cards, a latency chart, and recent probe results. It binds only to `127.0.0.1`. +![HTTPing live dashboard](docs/assets/httping-dashboard.gif) + Use `--no-open` to keep the browser closed, `--port` to select a fixed port, and `--history` to set the number of recent results kept in memory: diff --git a/CleanShot 2026-07-28 at 11.24.17.gif b/docs/assets/httping-dashboard.gif similarity index 99% rename from CleanShot 2026-07-28 at 11.24.17.gif rename to docs/assets/httping-dashboard.gif index 8ba0ab1..c519691 100644 Binary files a/CleanShot 2026-07-28 at 11.24.17.gif and b/docs/assets/httping-dashboard.gif differ