updated documentation for new release

dmportella · May 26, 2017 · abf785d · abf785d
1 parent 5b8fa31
commit abf785d
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 37 deletions.
diff --git a/DOCKERHUB.md b/DOCKERHUB.md
@@ -1,10 +1,11 @@
 A simple docker event beat server that will distribute docker events to plugins/actors to perform actions against them.
 
-# Supported tags and respective `Dockerfile` links
+# Supported tags and respective `Dockerfile` files
 
-* [`0.0.2`, (scratch/dockerfile)](https://github.com/dmportella/docker-beat/blob/0.0.2/dockerfile)
+* [`0.0.6`, `latest` (scratch/dockerfile)](https://github.com/dmportella/docker-beat/blob/0.0.6/dockerfile)
+* [`0.0.5`, (scratch/dockerfile)](https://github.com/dmportella/docker-beat/blob/0.0.5/dockerfile)
 * [`0.0.3`, (scratch/dockerfile)](https://github.com/dmportella/docker-beat/blob/0.0.3/dockerfile)
-* [`0.0.5`, `latest` (scratch/dockerfile)](https://github.com/dmportella/docker-beat/blob/0.0.5/dockerfile)
+* [`0.0.2`, (scratch/dockerfile)](https://github.com/dmportella/docker-beat/blob/0.0.2/dockerfile)
 
 ## Current support
 
@@ -34,37 +35,37 @@ The docker container supports Docker API Socket as a volume (not recommended) or
 See below the list of available arguments.
 
 ```
-docker-beat - Version: 0.0.5 Branch: master Revision: 55ea00b. OSArch: linux/amd64.
+docker-beat - Version: 0.0.6 Branch: master Revision: 5b8fa31. OSArch: linux/amd64.
 Daniel Portella (c) 2016
 Usage of ./bin/docker-beat:
   -consumer string
-      Consumer to use: Webhook, Rabbitmq, etc. (default "console")
+    	Consumer to use: Webhook, Rabbitmq, etc. (default "console")
   -docker-endpoint string
-      The Url or unix socket address for the Docker Remote API. (default "unix:///var/run/docker.sock")
+    	The Url or unix socket address for the Docker Remote API. (default "unix:///var/run/docker.sock")
   -help
-      Prints the help information.
+    	Prints the help information.
+  -indent
+    	Indent the json output.
   -rabbitmq-endpoint string
-      rabbitmq: The URL that events will be published too. (default "amqp://guest:guest@localhost:5672/")
+    	rabbitmq: The URL that events will be published too. (default "amqp://guest:guest@localhost:5672/")
   -rabbitmq-exchange string
-      rabbitmq: The exchange docker-beat will publish messages too. (default "docker-beat")
+    	rabbitmq: The exchange docker-beat will publish messages too. (default "docker-beat")
   -rabbitmq-exchange-type string
-      rabbitmq: The exchange type that docker-beat will create/connect too. (direct|fanout|topic|x-custom) (default "fanout")
+    	rabbitmq: The exchange type that docker-beat will create/connect too. (direct|fanout|topic|x-custom) (default "fanout")
   -rabbitmq-reliable
-      rabbitmq: The ensures messages published are confirmed.
+    	rabbitmq: The ensures messages published are confirmed.
   -rabbitmq-routing-key string
-      rabbitmq: The routing key for messages published to the exchange. (default: docker-event (default "docker-event")
+    	rabbitmq: The routing key for messages published to the exchange. (default: docker-event (default "docker-event")
   -verbose
-      Redirect trace information to the standard out.
+    	Redirect trace information to the standard out.
   -webhook-endpoint string
-      webhook: The URL that events will be POSTed too.
-  -webhook-indent
-      webhook: Indent the json output.
+    	webhook: The URL that events will be POSTed too.
   -webhook-skip-ssl-verify
-      webhook: Tells docker-beat to ignore ssl verification for the endpoint (not recommented).
+    	webhook: Tells docker-beat to ignore ssl verification for the endpoint (not recommented).
   -websocket-endpoint string
-      websocket: The URL that events will be streamed too.
+    	websocket: The URL that events will be streamed too.
   -websocket-origin string
-      websocket: The origin of the request to be used in the web socket stream.
+    	websocket: The origin of the request to be used in the web socket stream.
   -websocket-protocol string
-      websocket: The protocol to be used in the web socket stream.
+    	websocket: The protocol to be used in the web socket stream.
 ```
diff --git a/README.md b/README.md
@@ -9,6 +9,13 @@ A simple docker event beat server that will distribute docker events to plugins/
 
 [![dockeri.co](http://dockeri.co/image/dmportella/docker-beat)](https://hub.docker.com/r/dmportella/docker-beat/)
 
+### Supported tags and respective `Dockerfile` files
+
+* [`0.0.6`, `latest` (scratch/dockerfile)](https://github.com/dmportella/docker-beat/blob/0.0.6/dockerfile)
+* [`0.0.5`, (scratch/dockerfile)](https://github.com/dmportella/docker-beat/blob/0.0.5/dockerfile)
+* [`0.0.3`, (scratch/dockerfile)](https://github.com/dmportella/docker-beat/blob/0.0.3/dockerfile)
+* [`0.0.2`, (scratch/dockerfile)](https://github.com/dmportella/docker-beat/blob/0.0.2/dockerfile)
+
 ## Current support
 
 Currently `docker-beat` supports sending docker events to the following endpoints.
@@ -37,39 +44,39 @@ The docker container supports Docker API Socket as a volume (not recommended) or
 Should be simple to run the application locally it differs just slightly between OS.
 
 ```
-docker-beat - Version: 0.0.5 Branch: master Revision: 55ea00b. OSArch: linux/amd64.
+docker-beat - Version: 0.0.6 Branch: master Revision: 5b8fa31. OSArch: linux/amd64.
 Daniel Portella (c) 2016
 Usage of ./bin/docker-beat:
   -consumer string
-      Consumer to use: Webhook, Rabbitmq, etc. (default "console")
+    	Consumer to use: Webhook, Rabbitmq, etc. (default "console")
   -docker-endpoint string
-      The Url or unix socket address for the Docker Remote API. (default "unix:///var/run/docker.sock")
+    	The Url or unix socket address for the Docker Remote API. (default "unix:///var/run/docker.sock")
   -help
-      Prints the help information.
+    	Prints the help information.
+  -indent
+    	Indent the json output.
   -rabbitmq-endpoint string
-      rabbitmq: The URL that events will be published too. (default "amqp://guest:guest@localhost:5672/")
+    	rabbitmq: The URL that events will be published too. (default "amqp://guest:guest@localhost:5672/")
   -rabbitmq-exchange string
-      rabbitmq: The exchange docker-beat will publish messages too. (default "docker-beat")
+    	rabbitmq: The exchange docker-beat will publish messages too. (default "docker-beat")
   -rabbitmq-exchange-type string
-      rabbitmq: The exchange type that docker-beat will create/connect too. (direct|fanout|topic|x-custom) (default "fanout")
+    	rabbitmq: The exchange type that docker-beat will create/connect too. (direct|fanout|topic|x-custom) (default "fanout")
   -rabbitmq-reliable
-      rabbitmq: The ensures messages published are confirmed.
+    	rabbitmq: The ensures messages published are confirmed.
   -rabbitmq-routing-key string
-      rabbitmq: The routing key for messages published to the exchange. (default: docker-event (default "docker-event")
+    	rabbitmq: The routing key for messages published to the exchange. (default: docker-event (default "docker-event")
   -verbose
-      Redirect trace information to the standard out.
+    	Redirect trace information to the standard out.
   -webhook-endpoint string
-      webhook: The URL that events will be POSTed too.
-  -webhook-indent
-      webhook: Indent the json output.
+    	webhook: The URL that events will be POSTed too.
   -webhook-skip-ssl-verify
-      webhook: Tells docker-beat to ignore ssl verification for the endpoint (not recommented).
+    	webhook: Tells docker-beat to ignore ssl verification for the endpoint (not recommented).
   -websocket-endpoint string
-      websocket: The URL that events will be streamed too.
+    	websocket: The URL that events will be streamed too.
   -websocket-origin string
-      websocket: The origin of the request to be used in the web socket stream.
+    	websocket: The origin of the request to be used in the web socket stream.
   -websocket-protocol string
-      websocket: The protocol to be used in the web socket stream.
+    	websocket: The protocol to be used in the web socket stream.
 ```
 
 ### Linux, Darwin and FreeBSD