Skip to content

Commit 5e1bf16

Browse files
committed
adds a "why" section to the README
we also add the primary install command
1 parent 910b2ff commit 5e1bf16

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,20 @@
33
dead simple binary to check http status code returned from health-check
44
endpoint.
55

6+
## Why not just use cURL?
67

7-
## Install
8+
cURL can definitively do the job as long as you are willing to mix the shell
9+
script to parse the payload. Specially if you want to cover a range of status
10+
instead of a single HTTP code.
11+
12+
The `http_status_code_check` command removes the necessity of parsing the HTTP
13+
status codes and let you dealing only with the program exit code itself:
14+
- 0 - if the status code is inside the list of expected ones
15+
- 1 - if the status code is outside the list of expected ones
816

9-
...
17+
## Install
1018

19+
`cargo install http_status_code_check`
1120

1221
## Usage
1322

0 commit comments

Comments
 (0)