u8-mqtt 0.1.3 → 0.3.1

package/README.md

@@ -33,79 +33,62 @@ Targeting [MQTT-3.1.1 (v4)][spec-3.1.1] and [MQTT-5.0.0 (v5)][spec-5.0.0] compat
 
 ## Use
 
-```javascript
-// using NodeJS
-import mqtt_client from 'u8-mqtt/esm/node/v4.mjs'
-
-// or using Deno
-import mqtt_client from 'u8-mqtt/esm/deno/v4.mjs'
-
-// or using WebSockets
-import mqtt_client from 'u8-mqtt/esm/web/v4.mjs'
-
-
-const my_mqtt = mqtt_client()
-
-
-// Connect using NodeJS or Deno
-my_mqtt.with_tcp(1883, '127.0.0.1')
-
-// or connect using WebSockets
-my_mqtt.with_websock('ws://127.0.0.1:9001')
+- from [Web CDN](./docs/use_from_web_cdn.md)
+- from [Web bundler](./docs/use_from_web_bundler.md) like [Rollup][] or [ESBuild][]
+- from [NodeJS](./docs/use_from_nodejs.md)
+- from [Deno](./docs/use_from_deno.md)
 
+ [Rollup]: https://rollupjs.org
+ [ESBuild]: https://esbuild.github.io
 
-// use on_live to converse with the MQTT server
-my_mqtt.on_live = somewhere_in_your_code
 
+```javascript
+import mqtt_client from 'https://cdn.jsdelivr.net/npm/u8-mqtt/esm/web/index.js'
+// or import mqtt_client from 'u8-mqtt'
 
-// ...
-async function somewhere_in_your_code(my_mqtt) {
-  my_mqtt
-    .on_topic('u8-mqtt-demo/topic/:arg', (pkt, params, ctx) => {
-      console.log('topic:', params, [params.arg, pkt.utf8()])
-    })
-    .on_topic('u8-mqtt-demo/another/:first/:second', (pkt, params, ctx) => {
-      console.log('another:', params, [params.first, params.second, pkt.utf8()])
-    })
-    .subscribe_topic('u8-mqtt-demo/bye', (pkt, params, ctx) => {
-      console.log('other mqtt said bye:', params, [pkt.utf8()])
-    })
+let my_mqtt = mqtt_client()
+  .with_websock('wss://test.mosquitto.org:8081')
+  // or .with_tcp('tcp://test.mosquitto.org:1883')
+  .with_autoreconnect()
 
+await my_mqtt.connect()
 
-  await my_mqtt.connect({
-    client_id: ['my-mqtt--', '--demo'],
-    will: {
-      topic: 'u8-mqtt-demo/bye',
-      payload: 'gone!',
-    }
+my_mqtt.subscribe_topic(
+  'u8-mqtt/demo-simple/:topic',
+  (pkt, params, ctx) => {
+    console.log('topic packet', params, pkt, pkt.json())
   })
 
-  await my_mqtt.subscribe([
-    'u8-mqtt-demo/another/#',
-    'u8-mqtt-demo/topic/+',
-  ])
+await my_mqtt.json_send(
+  'u8-mqtt/demo-simple/live',
+  { note: 'from README example',
+    live: new Date().toISOString() })
+```
 
-  my_mqtt.publish({
-    topic: 'u8-mqtt-demo/topic/node-side-fun-test',
-    payload: 'awesome from both web and node',
-  })
+## Module size
 
-  my_mqtt.send(
-    'u8-mqtt-demo/another/apple/orange',
-    'MQTT Fruity fun')
+Built for small footprint with ES Modules (ESM) using embedded [u8-mqtt-packet][] and [regexparam][] libraries.
 
-}
-```
+| module                  |   brotli | minified |
+|:------------------------|---------:|---------:|
+| `u8-mqtt`               |   6476 B |  19895 B |
+| `u8-mqtt/esm/v5.min.js` |   6384 B |  19694 B |
+| `u8-mqtt/esm/v4.min.js` |   5290 B |  15287 B |
 
-## Sizes
+[automated sizing report](./docs/compressed.md)
 
-Built for small footprint with ES Modules (ESM) using embedded [u8-mqtt-packet][] and [regexparam][] libraries.
+#### MQTT Client sizes
+
+| minifeid | (x)  | Project        | Measurement |
+|---------:|-----:|----------------|-------------|
+|  187.0KB |  12x | [MQTT.js][]    | `curl -sL https://cdn.jsdelivr.net/npm/mqtt@4.0.1/dist/mqtt.min.js \| wc -c`
+|   32.3KB |   2x | [paho][]       | `curl -sL https://cdn.jsdelivr.net/npm/paho-mqtt@1.1.0/paho-mqtt.min.js \| wc -c`
+|   19.9KB | 1.3x | [u8-mqtt][] v5 | `cat ./u8-mqtt/esm/web/v5.min.mjs \| wc -c`
+|   15.5KB |   1x | [u8-mqtt][] v4 | `cat ./u8-mqtt/esm/web/v4.min.mjs \| wc -c`
 
-| Size  | (x) | Measurement
-|-------|-----|------------
-| 187KB | 13x | `curl -sL https://cdn.jsdelivr.net/npm/mqtt@4.0.1/dist/mqtt.min.js  \| wc -c`
-|  32KB |  2x | `curl -sL https://cdn.jsdelivr.net/npm/paho-mqtt@1.1.0/paho-mqtt.min.js \| wc -c`
-|  16KB |  1x | `cat ./u8-mqtt/esm/web/v4.min.mjs \| wc -c`
+ [MQTT.js]: https://github.com/mqttjs/MQTT.js/
+ [paho]: https://github.com/eclipse/paho.mqtt.javascript/
+ [u8-mqtt]: https://github.com/shanewholloway/js-u8-mqtt/
 
 
 ## Prior Art