Skip to content

Commit 22025fc

Browse files
committed
docs: update install,usage docs
1 parent 06579e4 commit 22025fc

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

+22-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,25 @@ It collects ping metrics and generates detailed reports for analysis.
66

77
This tool draws inspiration from both the [ping_exporter](https://github.com/czerwonk/ping_exporter) and [SmokePing](https://github.com/oetiker/SmokePing) repositories, combining their strengths and introducing additional enhancements.
88

9-
Please note that the project is still in its early stages of development, and there may be some issues or incomplete documentation.
9+
## install
10+
11+
```bash
12+
go get github.com/jimyag/pingexporter@latest
13+
```
14+
15+
or via [github release](https://github.com/jimyag/pingexporter/releases)
16+
17+
## usage
18+
19+
```bash
20+
pingexporter config.toml
21+
```
22+
23+
```bash
24+
curl http://localhost:9113/metrics
25+
26+
```
27+
28+
## config
29+
30+
see [config file](config.toml) for more details

0 commit comments

Comments
 (0)