Skip to content

Commit

Permalink
Update README options syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
marcbachmann committed Apr 26, 2014
1 parent 53b3dc9 commit 710e0ba
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ pdf.create(htmlString, options, callback)
```

## Options
`script`: Absolute path to a custom phantomjs script, use the file in lib/scripts as example
`timeout`: Timeout that will cancel phantomjs, milliseconds as Integer, default: 10000
`filename`: 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`: The directory path of the file that will be written. default: '/tmp'
`script`: Absolute path to a custom phantomjs script, use the file in lib/scripts as example
`timeout`: Timeout that will cancel phantomjs, milliseconds as Integer, default: 10000
`filename`: 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`: The directory path of the file that will be written. default: '/tmp'

The full options object gets converted to JSON and will get passed to the phantomjs script as third argument.
The full options object gets converted to JSON and will get passed to the phantomjs script as third argument.
There are more options concerning the paperSize, header & footer options inside the phantomjs script.

There are more options concerning the paperSize, header & footer options inside the phantomjs script.
Documentation will follow soon.
## documentations for more available options will follow soon :)

0 comments on commit 710e0ba

Please sign in to comment.