diff options
author | Heikki Kallasjoki <fis@zem.fi> | 2018-12-04 23:26:01 +0000 |
---|---|---|
committer | Heikki Kallasjoki <fis@zem.fi> | 2018-12-04 23:26:01 +0000 |
commit | f5c20e9c9b46ac6efe3c3948302e4e20718a5968 (patch) | |
tree | dda96bf692be1c71607306f2f836b50f9a57982b /README.md | |
parent | 65439870f86997a6c50170a17cf0e399a39020a6 (diff) | |
download | nano-exporter-f5c20e9c9b46ac6efe3c3948302e4e20718a5968.tar.gz nano-exporter-f5c20e9c9b46ac6efe3c3948302e4e20718a5968.tar.xz nano-exporter-f5c20e9c9b46ac6efe3c3948302e4e20718a5968.zip |
Documentation improvements.
Include OpenWrt feed and installation instructions, as well as more details (and a README link) on how to contribute to the project.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 29 |
1 files changed, 27 insertions, 2 deletions
diff --git a/README.md b/README.md index 55b66ce..801fcef 100644 --- a/README.md +++ b/README.md @@ -35,11 +35,36 @@ You can also use the bundled `Makefile`, which likely requires GNU Make. You can comment out collectors in the Makefile to leave them out of the build if you don't need them. -TODO: OpenWrt feed + package definition + instructions. - The metrics collection is highly Linux-specific. You probably won't have much luck on other operating systems. +### Including in an OpenWrt build + +If you're building an OpenWrt system, you can include this program by +adding the following line to your `feeds.conf` file: + +``` +src-git nanoexporter https://github.com/fis/nano-exporter.git;openwrt +``` + +Then update the feed, and install the package: + +```shell +./scripts/feeds update nanoexporter +./scripts/feeds install -p nanoexporter -a +``` + +The package `nano-exporter` should now be available in `make +menuconfig`, under the "Utilities" heading. + +## Issues and contributions + +Please report any issues on the [GitHub issues +page](https://github.com/fis/nano-exporter/issues). + +See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to +contribute patches and other code. + ## Collectors For the most part, the produced metrics try to loosely (but not |