Improve docs and document typed array argument

eugeneware · eugeneware · commit 30eb99b49bce · 2016-06-05T10:26:35.000+08:00
diff --git a/README.md b/README.md
@@ -16,14 +16,39 @@ $ npm install jpeg-js
 
 ### Decoding JPEGs
 
+Will decode a buffer or typed array into a `Buffer`;
+
 ``` js
+var jpeg = require('jpeg-js');
 var jpegData = fs.readFileSync('grumpycat.jpg');
 var rawImageData = jpeg.decode(jpegData);
+console.log(jpegData.data);
+/*
+{ width: 320,
+  height: 180,
+  data: <Buffer 5b 40 29 ff 59 3e 29 ff 54 3c 26 ff 55 3a 27 ff 5a 3e 2f ff 5c 3c 31 ff 58 35 2d ff 5b 36 2f ff 55 35 32 ff 5a 3a 37 ff 54 36 32 ff 4b 32 2c ff 4b 36 ... > }
+*/
+```
+
+To decode directly into a `Uint8Array`, pass `true` as the second argument to
+`decode`:
+
+``` js
+var jpeg = require('jpeg-js');
+var jpegData = fs.readFileSync('grumpycat.jpg');
+var rawImageData = jpeg.decode(jpegData, true); // return as Uint8Array
+console.log(jpegData.data);
+/*
+{ width: 320,
+  height: 180,
+  data: { '0': 91, '1': 64, ... } } // typed array
+*/
 ```
 
 ### Encoding JPEGs
 
 ``` js
+var jpeg = require('jpeg-js');
 var width = 320, height = 180;
 var frameData = new Buffer(width * height * 4);
 var i = 0;
@@ -39,6 +64,10 @@ var rawImageData = {
   height: height
 };
 var jpegImageData = jpeg.encode(rawImageData, 50);
+console.log(jpegImageData);
+/*
+<Buffer 5b 40 29 ff 59 3e 29 ff 54 3c 26 ff 55 3a 27 ff 5a 3e 2f ff 5c 3c 31 ff 58 35 2d ff 5b 36 2f ff 55 35 32 ff 5a 3a 37 ff 54 36 32 ff 4b 32 2c ff 4b 36 ... >
+*/
 ```
 
 ## License
