From 2c003b8a87eb7d3f41d72fcb36fbe2381d1928e8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C5=81ukasz=20Mierzwa?= <l.mierzwa@gmail.com>
Date: Thu, 30 Mar 2017 18:28:41 -0700
Subject: [PATCH] Document releases and tags

Fixes #27
---
 CONTRIBUTING.md |  6 ++++++
 README.md       | 25 +++++++++++++++++++++++--
 2 files changed, 29 insertions(+), 2 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d29bbf856..3d23a75af 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -5,6 +5,12 @@
 To get started follow `Building from source` section of the [README](README.md)
 file.
 
+## Git tags and branches
+
+Every release tag name will follow `vX.Y.Z` naming scheme, example: `v0.1.0`.
+Every release tree has a dedicated branch named `release-X.Y`, example:
+`release-0.1`.
+
 ## Testing changes
 
 To run included tests and check code style with `golint` run:
diff --git a/README.md b/README.md
index 53d526e06..bc38557a8 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,17 @@ to alert data, therefore safe to be accessed by wider audience.
 
 ![Screenshot](/screenshot.png)
 
+## Supported Alertmanager versions
+
+Alertmanager's API isn't stable yet and can change between releases, make sure
+that the correct version of unsee is used:
+
+* `0.1` release supports Alertmanager `0.4`
+* `0.2` release supports Alertmanager `0.5`
+
+`master` branch in git will always work with the latest supported Alertmanager
+release.
+
 ## Building and running
 
 ### Installing using the go command
@@ -18,6 +29,9 @@ unsee is go installable, so the easiest way is to run:
     go install github.com/cloudflare/unsee
 
 The `unsee` binary will be installed into `$GOPATH/bin` directory.
+Note that this will build the latest master version which might not work with
+your Alertmanager version. See
+[supported Alertmanager versions](#supported-alertmanager-versions).
 
 ### Building from source
 
@@ -25,9 +39,16 @@ To clone git repo and build the binary yourself run:
 
     git clone https://github.com/cloudflare/unsee $GOPATH/src/github.com/cloudflare/unsee
     cd $GOPATH/src/github.com/cloudflare/unsee
-    make
 
-`unsee` binary will be compiled in project directory.
+Check [supported Alertmanager versions](#supported-alertmanager-versions) and if
+needed switch to the release branch that supports your Alertmanager version.
+For example to build unsee `0.2.x` run:
+
+    git checkout -t release-0.2
+
+To finally compile `unsee` the binary run:
+
+    make
 
 ## Running