Skip to content

Commit

Permalink
added a note for implications regarding the reversion to original mqt…
Browse files Browse the repository at this point in the history
…t.js typings.
  • Loading branch information
sclausen committed Dec 2, 2018
1 parent b729f2e commit 41021d5
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
This library isn't just a wrapper around MQTT.js for angular >= 2.
It uses observables and takes care of subscription handling and message routing.

For reasons of convenience, I removed the copied typings from mqtt.js and added it as a dev-dependency while still bundling the browserified latest version of it.
This means although you have the possibility to use `mqtt`, `mqtts`, `tcp`, `ssl`, `wx` or `wxs` as the protocol in the client options, you can't, because this is a browser library where you can't conntect with something other than websockets. You also can't use `key`, `cert` and `ca` for the same reasons.

If you have any issues using this library, please visit it's [homepage](https://sclausen.github.io/ngx-mqtt/) and look for similar issues in the issue tracker before you file a bug.

## **ngx-mqtt >= 6 is only compatible with angular >= 6**

0 comments on commit 41021d5

Please sign in to comment.