From dcc833758af08b96626a480c1f2e9a15ae4ba5f3 Mon Sep 17 00:00:00 2001 From: Brian Caswell Date: Fri, 23 Aug 2024 11:30:50 -0400 Subject: [PATCH] update readme (#24) --- README.md | 42 ++++++++++++++++++++++++++++++++---------- 1 file changed, 32 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index a18c135..dc5ef1a 100644 --- a/README.md +++ b/README.md @@ -14,14 +14,38 @@ Usage: retry [OPTIONS] ... Arguments: ... + Options: - --retries [default: 3] - --min-duration minimum duration in tenths of a second [default: 10] - --max-duration maximum duration in tenths of a second - --jitter amount of randomization to add to the backoff [default: 0.3] - --factor backoff factor [default: 2] - -h, --help Print help - -V, --version Print version + --attempts + [default: 3] + + --min-duration + minimum duration + + Examples: `10ms`, `2s`, `5m 30s`, or `1h10m` + + [default: 10ms] + + --max-duration + maximum duration + + Examples: `10ms`, `2s`, `5m 30s`, or `1h10m` + + --jitter + amount of randomization to add to the backoff + + [default: 0.3] + + --factor + backoff factor + + [default: 2] + + -h, --help + Print help (see a summary with '-h') + + -V, --version + Print version ``` ## Installation @@ -51,8 +75,6 @@ The command executes, but fails $ retry false failed, retrying... failed, retrying... -failed, retrying... -failed, retrying... -Error: "continued to fail after 3 retries" +Error: "continued to fail after 3 attempts" $ ```