Skip to content

Commit 1eaaa16

Browse files
committed
README: Clarify transport docs a bit
1 parent 05cb926 commit 1eaaa16

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,10 @@ You can enable (all) logging using:
7171
msgflo-nodejs has a transport abstraction layer. So to support a new messaging system,
7272
implement `Client` and `MessageBroker` [interfaces](./src/interfaces.coffee).
7373

74-
You can then pass these into a `Participant`.
74+
You can then pass the Client instance into a `Participant`.
7575

76-
Or you can use `msgflo.transport.register('mytransport', myTransportModule)`, and then `msgflo.transport.getClient('mysystem://somehost:666')`.
77-
This will also work for specifying `msgflo-nodejs --broker` and for `MSGFLO_BROKER=` environment variable.
76+
Or you can register a new transport using `msgflo.transport.register('mytransport', myTransportModule)`.
77+
Then you can get a Client instance using `msgflo.transport.getClient('mytransport://somehost:666')`.
78+
This has the advantage of also working when specifying the broker URL using
79+
`msgflo-nodejs --broker` or `MSGFLO_BROKER=` environment variable.
7880

0 commit comments

Comments
 (0)