README.md in mosquitto-0.2 vs README.md in mosquitto-0.3
- old
+ new
@@ -4,13 +4,13 @@
The mosquitto gem is meant to serve as an easy, performant and standards compliant client for interacting with MQTT brokers.
The API consists of two classes:
-[Mosquitto::Client](http://rubydoc.info/github/bear-metal/mosquitto/master/Mosquitto/Client) - the client
+[Mosquitto::Client](http://rubydoc.info/github/xively/mosquitto/master/Mosquitto/Client) - the client
-[Mosquitto::Message](http://rubydoc.info/github/bear-metal/mosquitto/master/Mosquitto/Message) - returned from the client
+[Mosquitto::Message](http://rubydoc.info/github/xively/mosquitto/master/Mosquitto/Message) - returned from the client
## About MQTT and libmosquitto
[MQ Telemetry Transport](http://mqtt.org/) is :
@@ -35,11 +35,11 @@
See the [project website](http://mosquitto.org/) for more information.
## Requirements
-This gem links against version 1.2.3 of `libmosquitto` . You will need to install additional packages for your system.
+This gem links against version 1.3.1 of `libmosquitto` . You will need to install additional packages for your system.
### OS X
The preferred installation method for libmosquitto on OS X is with the [Homebrew](https://github.com/Homebrew/homebrew) package manager :
@@ -49,21 +49,21 @@
### Linux Ubuntu
``` sh
sudo apt-get update
-sudo apt-get install pkg-config cmake openssl
+sudo apt-get install pkg-config cmake openssl libc-ares-dev
```
-The current Ubuntu packages aren't on 1.2.3 yet - it's recommended to build libmosquitto from source (see below) until further notice. OpenSSL is an optional dependency - libmosquitto builds without it, however TLS specific features would not be available.
+The current Ubuntu packages aren't on 1.3.1 yet - it's recommended to build libmosquitto from source (see below) until further notice. OpenSSL is an optional dependency - libmosquitto builds without it, however TLS specific features would not be available.
### Building libmosquitto from source
``` sh
-wget http://mosquitto.org/files/source/mosquitto-1.2.3.tar.gz
-tar xzf mosquitto-1.2.3.tar.gz
-cd mosquitto-1.2.3
+wget http://mosquitto.org/files/source/mosquitto-1.3.1.tar.gz
+tar xzf mosquitto-1.3.1.tar.gz
+cd mosquitto-1.3.1
cmake .
sudo make install
```
## Compatibility
@@ -85,11 +85,11 @@
``` sh
gem install mosquitto
```
-The extension checks for libmosquitto presence as well as a 1.2.3 version.
+The extension checks for libmosquitto presence as well as a 1.3.1 version.
## Usage
### Threaded loop
@@ -178,21 +178,21 @@
### Callbacks
The following callbacks are supported (please follow links for further documentation) :
-* [connect](http://rubydoc.info/github/bear-metal/mosquitto/master/Mosquitto/Client:on_connect) - called when the broker sends a CONNACK message in response to a connection.
-* [disconnect](http://rubydoc.info/github/bear-metal/mosquitto/master/Mosquitto/Client:on_disconnect) - called when the broker has received the DISCONNECT command and has disconnected the client.
-* [log](http://rubydoc.info/github/bear-metal/mosquitto/master/Mosquitto/Client:on_log) - should be used if you want event logging information from the client library.
-* [subscribe](http://rubydoc.info/github/bear-metal/mosquitto/master/Mosquitto/Client:on_subscribe) - called when the broker responds to a subscription request.
-* [unsubscribe](http://rubydoc.info/github/bear-metal/mosquitto/master/Mosquitto/Client:on_unsubscribe) - called when the broker responds to a unsubscription request.
-* [publish](http://rubydoc.info/github/bear-metal/mosquitto/master/Mosquitto/Client:on_publish) - called when a message initiated with Mosquitto::Client#publish has been sent to the broker successfully.
-* [message](http://rubydoc.info/github/bear-metal/mosquitto/master/Mosquitto/Client:on_message) - called when a message is received from the broker.
+* [connect](http://rubydoc.info/github/xively/mosquitto/master/Mosquitto/Client:on_connect) - called when the broker sends a CONNACK message in response to a connection.
+* [disconnect](http://rubydoc.info/github/xively/mosquitto/master/Mosquitto/Client:on_disconnect) - called when the broker has received the DISCONNECT command and has disconnected the client.
+* [log](http://rubydoc.info/github/xively/mosquitto/master/Mosquitto/Client:on_log) - should be used if you want event logging information from the client library.
+* [subscribe](http://rubydoc.info/github/xively/mosquitto/master/Mosquitto/Client:on_subscribe) - called when the broker responds to a subscription request.
+* [unsubscribe](http://rubydoc.info/github/xively/mosquitto/master/Mosquitto/Client:on_unsubscribe) - called when the broker responds to a unsubscription request.
+* [publish](http://rubydoc.info/github/xively/mosquitto/master/Mosquitto/Client:on_publish) - called when a message initiated with Mosquitto::Client#publish has been sent to the broker successfully.
+* [message](http://rubydoc.info/github/xively/mosquitto/master/Mosquitto/Client:on_message) - called when a message is received from the broker.
### TLS / SSL
-libmosquitto builds with TLS support by default, however [pre-shared key (PSK)](http://rubydoc.info/github/bear-metal/mosquitto/master/Mosquitto/Client:tls_psk_set) support is not available when linked against older OpenSSL versions.
+libmosquitto builds with TLS support by default, however [pre-shared key (PSK)](http://rubydoc.info/github/xively/mosquitto/master/Mosquitto/Client:tls_psk_set) support is not available when linked against older OpenSSL versions.
``` ruby
tls_client = Mosquitto::Client.new
tls_client.logger = Logger.new(STDOUT)
@@ -205,28 +205,28 @@
tls_client.tls_opts_set(Mosquitto::SSL_VERIFY_PEER, "tlsv1.2", nil)
tls_client.tls_set('/path/to/mosquitto.org.crt'), nil, nil, nil, nil)
tls_client.connect('test.mosquitto.org', 8883, 10)
```
-See [documentation](http://rubydoc.info/github/bear-metal/mosquitto) for the full API specification.
+See [documentation](http://rubydoc.info/github/xively/mosquitto) for the full API specification.
## Contact, feedback and bugs
This extension is currently maintained by Lourens Naudé (http://github.com/methodmissing) and contributors.
-Please file bugs / issues and feature requests on the [issue tracker](https://github.com/bear-metal/mosquitto/issues)
+Please file bugs / issues and feature requests on the [issue tracker](https://github.com/xively/mosquitto/issues)
## Development
To run the tests, you can use RVM and Bundler to create a pristine environment for mosquitto development/hacking.
Use 'bundle install' to install the necessary development and testing gems:
``` sh
bundle install
-rake
+bundle exec rake
```
-Tests by default run against the public `test.mosquitto.org` MQTT server, which supports TLS as well. More information is available at http://test.mosquitto.org/. Alternatively, should you wish you run tests against a local MQTT broker, change the following constants in the test helper to `localhost`:
+Tests by default run against an MQTT server on localhost, which is expected to support TLS on port 8883 as well.
``` ruby
class MosquittoTestCase < Test::Unit::TestCase
TEST_HOST = "localhost"
TEST_PORT = 1883
@@ -235,10 +235,10 @@
TLS_TEST_PORT = 8883
```
## Resources
-Documentation available at http://rubydoc.info/github/bear-metal/mosquitto
+Documentation available at http://rubydoc.info/github/xively/mosquitto
## Special Thanks
* Roger Light - for libmosquitto