Add a note about flag conventions

this note can be removed in half a year or so.

Fixes #147.

Signed-off-by: Matthias Rampke <mr@soundcloud.com>
This commit is contained in:
Matthias Rampke 2018-08-28 08:08:00 +00:00
parent 0ad6f7e7cb
commit 95d60eed01
No known key found for this signature in database
GPG key ID: 2CDE413A9BD0A5BC

View file

@ -41,6 +41,12 @@ without values (`#some_tag`) are not supported.
## Building and Running
NOTE: Version 0.7.0 switched to the [kingpin](https://github.com/alecthomas/kingpin) flags library. With this change, flag behaviour is POSIX-ish:
* long flags start with two dashes (`--version`)
* multiple short flags can be combined (but there currently is only one)
* flag processing stops at the first `--`
$ go build
$ ./statsd_exporter --help
usage: statsd_exporter [<flags>]