Skip to content

Commit 1946c01

Browse files
committed
fix readme
1 parent dff015d commit 1946c01

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

README.adoc

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,30 @@ Unfortunately there are few to nothing libraries natively suitable to be used in
66

77
The Moquette library is Java MQTT broker based on an eventing model with Netty. The library has a good performance and is desegned with embedding support out of the box. Its configuration is compatible with well known Mosquitto Open Source MQTT server.
88

9-
Being combained together there and empowered by Clojure - these tools open the way to painless M2M communications for services written in Clojure.
9+
When being combined - these tools open the way to painless M2M communications for services written in Clojure.
10+
11+
As always we prefer to have things tiny and as simple as possible.
1012

1113
== Compatibility
1214

13-
The following implementations are successfully passes production tests:
15+
The following implementations are successfully passed production tests:
1416

1517
- Moquette
1618
- Mosquitto
1719
- Paho
1820
- MQTT.js
1921
- DKD/Brownie
2022

23+
any other tool that conform MQTT specs should pass too, we believe.
24+
2125
== Usage
2226

2327
The usage pattern is simple:
2428

2529
- define handlers
2630
- create broker instance
2731
- start the service
28-
- serve messages
32+
- start serve messages
2933

3034
=== Defining handlers
3135

@@ -42,7 +46,7 @@ The handlers record should implement `InterceptHandler` interface
4246
(getInterceptedMessageTypes [_] InterceptHandler/ALL_MESSAGE_TYPES))
4347
----
4448

45-
The full set of method to be overrided:
49+
The full set of method to be overridden:
4650

4751
. onPublish
4852
. onConnect
@@ -58,9 +62,9 @@ The `ALL_MESSAGE_TYPES` vector contains the whole bunch of the related messages
5862

5963
=== Creating instance
6064

61-
The library contains default `SimpleBroker` implementation written in Java that requires resources' configuration file name to be passed into construtor.
65+
The library contains default `SimpleBroker` implementation written in Java that requires resources' configuration file name to be passed into constructor.
6266

63-
In order to manage the instance itnshould be passed as a parameter into the Clojure record implements `CljBroker` interface.
67+
In order to manage the instance comfortably it should be passed as a parameter into the Clojure record implements `CljBroker` interface.
6468

6569
.CljBroker interface definition
6670
[source, clojure]
@@ -84,10 +88,10 @@ so the instantiation of the complete Broker is looks like:
8488

8589
=== Starting the service
8690

87-
The clojure interface support two approaches:
91+
The Clojure interface supports two approaches:
8892

89-
. controling the instance by calling `start`/`stop` methods (that fully corresponds to its Java interface)
90-
. controling the instance by `with-open` macro
93+
. controlling the instance by calling `start`/`stop` methods (that fully corresponds to its Java interface)
94+
. controlling the instance by `with-open` macro
9195

9296
.start/stop
9397
[source,clojure]
@@ -121,4 +125,4 @@ The clojure interface support two approaches:
121125

122126
© 2022 Fern Flower Lab
123127

124-
Distributed under the MIT License.
128+
Distributed under the MIT License.

0 commit comments

Comments
 (0)