Merge pull request #142 from cloudflare/update-docs

Minor README updates

CONTRIBUTING.md

@@ -36,7 +36,7 @@ To update specific vendor package run `govendor` manually:
 
 See [govendor](https://github.com/kardianos/govendor) documentation for details.
 
-## Javascript & CSS assets
+## Javascript & CSS assets and HTML templates
 
 JS and CSS assets are also vendored into `assets/static` directory.
 There is a make target that allows to fetch all needed files from the
@@ -50,6 +50,16 @@ inside `assets/static` directory. In this case you will also need to manually
 include it in the `templates/js.html` template file (managed assets are all
 included automatically).
 
+Once assets dir is modified please run:
+
+    make bindata_assetfs.go
+
+This will rebuild [https://github.com/elazarl/go-bindata-assetfs](binary assets)
+file. Be sure to include it in the commit.
+Same applies to HTML template files, please rebuild bindata_assetfs.go before
+commit. Note that Makefile targets are setup to run it automatically if changes
+are detected, so it's usually not needed for development.
+
 ## Running
 
 To build and start `unsee` from local branch see `Running` section of the

README.md

@@ -4,8 +4,11 @@ Alert dashboard for [Prometheus Alertmanager](https://prometheus.io/docs/alertin
 
 Alertmanager UI is useful for browsing alerts and managing silences, but it's
 lacking as a dashboard tool - unsee aims to fill this gap.
-It's developed as a dedicated tool as it's intended to provide only read access
-to alert data, therefore safe to be accessed by wider audience.
+Starting with `0.7.0` release it can also aggregate alerts from multiple
+Alertmanager instances, running either in HA mode or separate. Duplicated alerts
+are deduplicated so only unique alerts are displayed. Each alert is tagged with
+names of all  Alertmanager instances it was found at and can be filtered based
+on those tags.
 
 ![Screenshot](/screenshot.png)
 
@@ -18,6 +21,9 @@ _RSS to email_ notifications, like [Blogtrottr](https://blogtrottr.com/).
 
 Alertmanager's API isn't stable yet and can change between releases.
 unsee currently supports Alertmanager `0.4`, `0.5`, `0.6` and `0.7`.
+Due to API differences between those releases some features will work
+differently or be missing, it's recommended to use the latest supported
+Alertmanager version.
 
 ## Security
 
@@ -194,7 +200,9 @@ This variable is required and there is no default value.
 #### DEBUG
 
 Will enable [gin](https://github.com/gin-gonic/gin) debug mode. This will
-configure to print out more debugging information on startup.
+configure to print out more debugging information on startup and enable
+[https://golang.org/pkg/net/http/pprof/](pprof) debug endpoints.
+
 Examples:
 
     DEBUG=true