Skip to content
This repository was archived by the owner on Nov 16, 2020. It is now read-only.

Commit b604f81

Browse files
Rework README.md
1 parent 9546e6f commit b604f81

File tree

1 file changed

+18
-12
lines changed

1 file changed

+18
-12
lines changed

README.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,11 @@
1-
RabbitMQ Web MQTT plugin
2-
========================
1+
# RabbitMQ Web MQTT plugin
32

4-
This project is a simple bridge between "RabbitMQ-MQTT" plugin and
5-
Websocket.
63

7-
Once started the plugin opens a SockJS endpoint on prefix "/ws" on
8-
port 15675. For example, a valid SockJS endpoint URL may look like:
9-
"ws://127.0.0.1:15675/ws".
4+
This plugin provides a support for MQTT-over-WebSockets to
5+
RabbitMQ.
106

11-
Once the server is started you should be able to establish a Websocket
12-
connection to this URL. You will be able to communicate using the
13-
usual MQTT protocol over it.
147

15-
Installation
16-
------------
8+
## Installation
179

1810
Generic build instructions are at:
1911

@@ -22,3 +14,17 @@ Generic build instructions are at:
2214
Instructions on how to install a plugin into RabbitMQ broker:
2315

2416
* http://www.rabbitmq.com/plugins.html#installing-plugins
17+
18+
19+
## Usage
20+
21+
Once the server is started you should be able to establish a Websocket
22+
connection to `ws://127.0.0.1:15675/ws`. You will be able to communicate using the
23+
usual MQTT protocol over it.
24+
25+
26+
## Copyright and License
27+
28+
(c) Pivotal Software Inc, 2007-2016.
29+
30+
Released under the same license as RabbitMQ. See LICENSE for details.

0 commit comments

Comments
 (0)