Skip to content

Commit c3ae686

Browse files
authored
Merge pull request #17 from lazy-electron-consulting/2-cross-compile
improve docs
2 parents 8aee4ee + b74ad20 commit c3ae686

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,20 @@
33
[Prometheus exporter](https://prometheus.io/docs/instrumenting/exporters/) for
44
Renogy charge controllers.
55

6-
Usage: `./renogy-exporter config.yaml`
6+
## Usage
77

8-
See `renogy.yaml` for an example of the config syntax.
8+
- download a binary from the github releases or build from source using `make
9+
build`
10+
- connect your computer to a renogy device, I'm using a renogy brand [RS485 to USB serial cable](https://www.renogy.com/rs485-to-usb-serial-cable/)
11+
- run `./renogy-exporter config.yaml`
12+
- see your metrics via http
13+
14+
See `renogy.yaml` for an example of the config syntax that works for me.
15+
16+
## Releasing
17+
18+
- merging to `main` will make new "latest" binaries
19+
- push a tag w/ `v$SEMVER` to make a versioned binaries
920

1021
## References
1122

0 commit comments

Comments
 (0)