From f817b8a5762e98e3e5d615de28319137c758e3a6 Mon Sep 17 00:00:00 2001 From: Nathan Wittstock Date: Mon, 30 Jan 2017 18:35:16 -0800 Subject: [PATCH] fix padding help message, version compatibility notes (#5) * fix padding help message * improved help line, version compatibility notes --- README.md | 11 +++++++++++ cmd/secure-operator/main.go | 2 +- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e88653f..12a976d 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,16 @@ to use one of the stable releases, use its version tag when pulling, e.g.: docker pull fardog/secureoperator:v1.0.3 ``` +## Version Compatibility + +This package follows [semver][] for its tagged releases. The `master` branch is +always considered stable, but may break API compatibility. If you require API +stability, either use the tagged releases or mirror on gopkg.in: + +``` +go get -u gopkg.in/fardog/secureoperator.v1 +``` + ## Security Note that while DNS requests are made over HTTPS, this does not imply "secure"; @@ -87,3 +97,4 @@ This owes heavily to the following work: [releases]: https://github.com/fardog/secureoperator/releases [docker]: https://www.docker.com/ [issues]: https://github.com/fardog/secureoperator/issues +[semver]: http://semver.org/ diff --git a/cmd/secure-operator/main.go b/cmd/secure-operator/main.go index c8e3453..615602d 100644 --- a/cmd/secure-operator/main.go +++ b/cmd/secure-operator/main.go @@ -25,7 +25,7 @@ var ( pad = flag.Bool( "pad", true, - "Randomly pad requests to vary request length", + "Pad Google DNS-over-HTTPS requests to identical length", ) logLevel = flag.String(