update documentation

jandelgado · Jul 5, 2019 · 2cd1f7f · 2cd1f7f
1 parent 5991949
commit 2cd1f7f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,11 @@
 
 # Changelog for rabtap
 
+## v1.18 (2019-07-05)
+
+* fix: tap: allow colons in exchange names by escaping them (`exchange\\:with\\:colon`).
+  Fixes #13.
+
 ## v1.17 (2019-06-13)
 
 * Timestamp when message was received by rabtap now stored in JSON format

diff --git a/README.md b/README.md
@@ -259,7 +259,9 @@ The `tap` command allows to tap exchanges and transparently receives messages
 sent to the exchanges.  Rabtap automatically reconnects on connections
 failures. The syntax of the `tap` command is `rabtap tap [--uri URI] EXCHANGES`
 where the `EXCHANGES` argument specifies the exchanges and binding keys to use.
-The `EXCHANGES` argument is of the form `EXCHANGE:[KEY][,EXCHANGE:[KEY]]*`.
+The `EXCHANGES` argument is of the form `EXCHANGE:[KEY][,EXCHANGE:[KEY]]*`. If
+the exchange name contains a colon, use `\\:` to escape it, e.g.
+`myexchange\\:with\\:colons:KEY`.
 
 The acutal format of the binding key depends on the exchange type (e.g.
 direct, topic, headers) and is described in the [RabbitMQ