New module api

.travis.yml

@@ -0,0 +1,4 @@
+language: node_js
+node_js:
+  - "0.10"
+  - "0.11"

README.md

@@ -7,39 +7,46 @@
 [Example Receipt](http://public.admintools.ch/gh/html-pdf/order.pdf)
 
 
+## Example
 ```javascript
 var fs = require('fs');
-var pdf = require('./lib');
+var pdf = require('html-pdf');
 var html = fs.readFileSync('./test/businesscard.html', 'utf8')
-pdf.create(html, { width: '50mm', height: '90mm'}, function(err, buffer) {
+var options = { filename: './businesscard.pdf', format: 'Letter' };
+
+pdf.create(html, options).toFile(function(err, res) {
   if (err) return console.log(err);
-  fs.writeFile('businesscard.pdf', buffer);
+  console.log(res); // { filename: '/tmp/html-pdf-8ymPV.pdf' }
 });
 ```
 
 ## API
-Currently there is only one function
-```javascript
-var pdf = require('html-pdf');
-var callback = function(err, buffer){}
-pdf.create(htmlString, options, callback)
+
+```js
+pdf.create(html [, options]).toFile([filepath, ]callback)
+pdf.create(html [, options]).toBuffer(callback)
+pdf.create(html [, options]).toStream(callback)
+
+// for backwards compatibility
+pdf.create(html [, options], callback)
+
 ```
 
+
 ## Options
 ```javascript
 config = {
-  // Script options
-  script: '/url'             // Absolute path to a custom phantomjs script, use the file in lib/scripts as example
-  timeout: 10000           // Timeout that will cancel phantomjs, in milliseconds
+
+  // Export options
+  "directory": "/tmp"        // The directory the file gets written into if not using .toFile(filename, callback). default: '/tmp'
 
   // Papersize Options: http://phantomjs.org/api/webpage/property/paper-size.html
-  "height": "",              // allowed units: mm, cm, in, px
-  "width": "",               // allowed units: mm, cm, in, px
+  "height": "10.5in",        // allowed units: mm, cm, in, px
+  "width": "8in",            // allowed units: mm, cm, in, px
   - or -
-  "format": "A4",            // allowed units: A3, A4, A5, Legal, Letter, Tabloid
+  "format": "Letter",        // allowed units: A3, A4, A5, Legal, Letter, Tabloid
   "orientation": "portrait", // portrait or landscape
 
-
   // Page options
   "border": "0"              // default is 0, units: mm, cm, in, px
   "header": {
@@ -50,18 +57,15 @@ config = {
     "height": "28mm",
     "contents": '<span style="color: #444;">{{page}}</span>/<span>{{pages}}</span>'
   },
-
 
   // File options
   "type": "pdf",             // allowed file types: png, jpeg, pdf
   "quality": "75",           // only used for types png & jpeg
 
+  // Script options
+  "script": '/url'           // Absolute path to a custom phantomjs script, use the file in lib/scripts as example
+  "timeout": 10000           // Timeout that will cancel phantomjs, in milliseconds
 
-  // Export options
-  "buffer": true,            // only supported on certain systems
-  - or -
-  "filename": "/tmp/html-pdf-123-123.pdf" // The file path of the file that will be written. If you want to save the file permanently, you have to pass this option.
-  "directory": "/tmp"        // The directory the file gets written into if no filename is defined. default: '/tmp' 
 }
 ```