Added new example

README.md

@@ -88,7 +88,7 @@ Spritesmith.run({src: sprites}, function handleResult (err, result) { /* ... */
 
 ```js
 // Load in dependencies
-var Spritesmtih = require('spritesmith');
+var Spritesmith = require('spritesmith');
 
 // Generate our spritesheet
 var sprites = ['fork.png', 'github.png', 'twitter.png'];
@@ -99,6 +99,28 @@ Spritesmith.run({src: sprites}, function handleResult (err, result) {
 });
 ```
 
+### Usage with streaming output
+We support streaming output by breaking down `run` into 2 parts:
+
+```js
+// Load in dependencies
+var Spritesmith = require('spritesmith');
+
+// Create a new spritesmith and process our images
+var sprites = ['fork.png', 'github.png', 'twitter.png'];
+var spritesmith = new Spritesmith();
+spritesmith.createImages(sprites, function handleImages (err, images) {
+  images[0].width; // Width of image
+  images[0].height; // Height of image
+
+  // Create our result
+  var result = spritesmith.processImages(images);
+  result.image; // Readable stream outputting image
+  result.coordinates; // Object mapping filename to {x, y, width, height} of image
+  result.properties; // Object with metadata about spritesheet {width, height}
+});
+```
+
 ## Documentation
 `spritesmith` exports a `Spritesmith` constructor as its `module.exports`.
 

docs/getting-started-stream.js

@@ -0,0 +1,30 @@
+// Load in dependencies
+var fs = require('fs');
+var Spritesmith = require('../');
+
+// Generate our spritesheet
+var spritesmith = new Spritesmith();
+spritesmith.createImages({
+  src: [
+    __dirname + '/fork.png',
+    __dirname + '/github.png',
+    __dirname + '/twitter.png'
+  ]
+}, function handleImages (err, images) {
+  // If there was an error, throw it
+  if (err) {
+    throw err;
+  }
+
+  // Otherwise, log info
+  console.log(images[0].width); // Width of image
+  console.log(images[0].height); // Height of image
+
+  // Create our result
+  var result = spritesmith.processImages(images);
+  console.log(JSON.stringify(result.coordinates, null, 2)); // Object mapping filename to {x, y, width, height} of image
+  console.log(JSON.stringify(result.properties, null, 2)); // Object with metadata about spritesheet {width, height}
+
+  // and output the image
+  result.image.pipe(fs.createWriteStream(__dirname + '/getting-started-stream.png'));
+});

docs/spritesheet.js

@@ -1,9 +1,9 @@
 // Load in dependencies
 var fs = require('fs');
-var spritesmith = require('../');
+var Spritesmith = require('../');
 
 // Generate our spritesheet
-spritesmith({
+Spritesmith.run({
   src: [
     __dirname + '/fork.png',
     __dirname + '/github.png',

src/smith.js

@@ -107,6 +107,7 @@ Spritesmith.prototype = {
   },
   processImages: function (images, options) {
     // Set up our algorithm/layout placement and export configuration
+    options = options || {};
     var algorithmName = options.algorithm || algorithmDefault;
     var layer = new Layout(algorithmName, options.algorithmOpts);
     var padding = options.padding || 0;