From 95d60eed014417267c7037a6dbe651a3118baee1 Mon Sep 17 00:00:00 2001
From: Matthias Rampke <mr@soundcloud.com>
Date: Tue, 28 Aug 2018 08:08:00 +0000
Subject: [PATCH] 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>
---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.md b/README.md
index e364ed5..d5d0ff2 100644
--- a/README.md
+++ b/README.md
@@ -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>]