Merge pull request #66 from allegro/fixes_#64_#65_update_readme

Update README.md

Author: janisz

.travis.yml

@@ -1,12 +1,25 @@
 language: go
 
 go:
-  - 1.5
+  - 1.6
   - tip
 before_install:
+  - go get golang.org/x/tools/cmd/cover
   - go get github.com/axw/gocov/gocov
+  - go get github.com/modocache/gover
   - go get github.com/mattn/goveralls
   - if ! go get github.com/golang/tools/cmd/cover; then go get golang.org/x/tools/cmd/cover; fi
 script:
   - make deps
-  - $HOME/gopath/bin/goveralls -package ./... -service=travis-ci
+  - go test -coverprofile=apps.coverprofile ./apps
+  - go test -coverprofile=config.coverprofile ./config
+  - go test -coverprofile=consul.coverprofile ./consul
+  - go test -coverprofile=events.coverprofile ./events
+  - go test -coverprofile=marathon.coverprofile ./marathon
+  - go test -coverprofile=metrics.coverprofile ./metrics
+  - go test -coverprofile=sync.coverprofile ./sync
+  - go test -coverprofile=utils.coverprofile ./utils
+  - go test -coverprofile=web.coverprofile ./web
+  - go test -coverprofile=main.coverprofile
+  - $HOME/gopath/bin/gover
+  - $HOME/gopath/bin/goveralls -coverprofile=gover.coverprofile -service travis-ci

README.md

@@ -4,9 +4,28 @@
 Register [Marathon](https://mesosphere.github.io/marathon/) Tasks as [Consul](https://www.consul.io/) Services for service discovery.
 
 `marathon-consul` takes information provided by the [Marathon event bus](https://mesosphere.github.io/marathon/docs/event-bus.html) and
-forwards it to Consul agents. It also re-syncs all the information from Marathon 
+forwards it to Consul agents. It also re-syncs all the information from Marathon
 to Consul on startup and repeats it with given interval.
 
+## Code
+
+This project is based on
+
+* [mesos-consul](https://github.com/CiscoCloud/mesos-consul)
+* [marathon-consul](https://github.com/CiscoCloud/marathon-consul)
+
+### Differences
+
+* CiscoCloud/marthon-consul copies application information to Consul KV while
+allegro/marathon-consul registers tasks as Consul services
+(it is more similar to CiscoCloud/mesos-consul)
+* CiscoCloud/mesos-consul uses polling while allegro/marathon-consul uses
+[Marathon's event bus](https://mesosphere.github.io/marathon/docs/event-bus.html)
+to detect changes
+* CiscoCloud/marathon-consul is no longer developed
+(see [comment](https://github.com/CiscoCloud/marathon-consul/issues/17#issuecomment-161678453))
+
+
 ## Installation
 
 ### Installing from source code
@@ -69,6 +88,7 @@ curl -X POST 'http://marathon.service.consul:8080/v2/eventSubscriptions?callback
 
 ## Usage
 
+- marathon-consul should be installed on all Marathon masters, and subscription should be set to `localhost` to reduce network traffic
 - Consul Agents should be available at every Mesos Slave, tasks will be registered at hosts their run on.
 - Only tasks which are labeled as `consul` will be registered in Consul. By default the registered service name is equal to Marathon's application name. 
   A different name can be provided as the label's value, e.g. `consul:customName`. As an exception of the rule, for backward compatibility with the `0.3.x` branch, a value of `true` is resolved to the default name.
@@ -130,17 +150,10 @@ The following section describes known limitations in `marathon-consul`.
 
 * Every marathon application needs to have a unique service name in Consul.
 * In Marathon when a deployment changing the application's service name (by changing its `labels`) is being stopped, it changes app's configuration anyway.
-  This means we loose the link between the app and the services registered with the old name in Consul. 
+  This means we loose the link between the app and the services registered with the old name in Consul.
   Later on, if another deployment takes place, new services are registered with a new name, the old ones are not being deregistered though.
   A scheduled sync is required to wipe them out.
 
-## Code
-
-This project is based on
-
-* [mesos-consul](https://github.com/CiscoCloud/mesos-consul)
-* [marathon-consul](https://github.com/CiscoCloud/marathon-consul)
-
 ## License
 
 Marathon-consul is released under the Apache 2.0 license (see [LICENSE](LICENSE))