Skip to content

Commit 7c77db9

Browse files
authored
Update Readme
1 parent 991f212 commit 7c77db9

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

README.md

+9-12
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ SpO₂ doesn't support SSL out of the box, if you need [you can setup an Nginx s
1212

1313
## Usage
1414

15-
You must have installed Rust on your computer.
15+
You must have [installed Rust](https://rustup.rs/) on your computer first.
1616

1717
```bash
1818
# to try it in debug mode
@@ -36,38 +36,35 @@ cargo run --release
3636

3737
### Add or Update a new URL to health check
3838

39+
Calling this route is "kind of" idenpotent, it means that it will not run another health checker on this URL but the custom json data will be updated.
40+
3941
```bash
4042
curl -i -X PUT 'http://127.0.0.1:8000/?url=http%3A%2F%2Flocalhost%2Fhealth' -d '"your custom json data"'
4143

4244
# Note that 'http%3A%2F%2Flocalhost%2Fhealth' is the url to health check
4345
# but it is url encoded and correspond to 'http://localhost/health'
44-
45-
# Calling this function is "kind of" idenpotent, it means that it will not run another
46-
# health checker on this URL but the custom json data will be updated
4746
```
4847

4948
### Remove an health checked URL
5049

50+
Calling this route will remove the URL from the health check pool and return you the custom json data associated with it.
51+
5152
```bash
5253
curl -i -X DELETE 'http://127.0.0.1:8000/?url=http%3A%2F%2Flocalhost%2Fhealth'
53-
54-
# Calling this function will remove the URL from the health check pool
55-
# and return you the custom json data you associated to it
5654
```
5755

5856
### Get an health checked URL data
5957

58+
Will return the associated data of an already health checked URL.
59+
6060
```bash
6161
curl -i -X GET 'http://127.0.0.1:8000/?url=http%3A%2F%2Flocalhost%2Fhealth'
62-
63-
# Will return the associated data of an already health checked URL
6462
```
6563

6664
### Get all the health checked URLs
6765

66+
Will return the list of all the health checked URLs aloang with the data associated with them.
67+
6868
```bash
6969
curl -i -X GET 'http://127.0.0.1:8000/all'
70-
71-
# Will return the list of all the health checked URLs
72-
# with the data associated with them
7370
```

0 commit comments

Comments
 (0)