diff options
| author | Michael Williamson <mike@zwobble.org> | 2014-03-16 17:21:10 +0000 |
|---|---|---|
| committer | Michael Williamson <mike@zwobble.org> | 2014-03-16 17:21:10 +0000 |
| commit | e4dd30342017bfa0fabec653add92a8e2188f13c (patch) | |
| tree | 3d5083ebb271a7090d26f2d3a986df414989b5a1 | |
| parent | f5b9b1c8632de9f2066bc45ded336d1e04e64aab (diff) | |
Document input options for the browser
| -rw-r--r-- | README.md | 5 |
1 files changed, 4 insertions, 1 deletions
@@ -126,7 +126,10 @@ var options = { Converts the source document to HTML. * `input`: an object describing the source document. - To read the file found at `path`, pass in `{path: path}`. + While running on node.js, + to read the file found at `path`, pass in `{path: path}`. + While running in the browser, + to read the file stored in an array buffer, pass in `{arrayBuffer: arrayBuffer}`. * `options` (optional): options for the conversion. May have the following properties: |
