v1.1.0

README.md

@@ -1,2 +1,38 @@
 # tunnel-packer
+
 A strategy for packing and unpacking tunneled network messages (or any stream) in node.js
+
+Examples
+
+```
+var Packer = require('tunnel-packer');
+
+Packer.create({
+  onmessage: function (msg) {
+    // msg = { family, address, port, service, data };
+  }
+, onend: function (msg) {
+    // msg = { family, address, port };
+  }
+, onerror: function (err) {
+    // err = { message, family, address, port };
+  }
+});
+
+var chunk = Packer.pack(address, data, service);
+var addr = Packer.socketToAddr(socket);
+var id = Packer.addrToId(address);
+var id = Packer.socketToId(socket);
+
+var myDuplex = Packer.Stream.create(socketOrStream);
+
+var myTransform = Packer.Transform.create({
+  address: {
+    family: '...'
+  , address: '...'
+  , port: '...'
+  }
+  // hint at the service to be used
+, service: 'https'
+});
+```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tunnel-packer",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A strategy for packing and unpacking tunneled network messages (or any stream)",
   "main": "index.js",
   "scripts": {