summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2014-03-16 17:21:10 +0000
committerMichael Williamson <mike@zwobble.org>2014-03-16 17:21:10 +0000
commite4dd30342017bfa0fabec653add92a8e2188f13c (patch)
tree3d5083ebb271a7090d26f2d3a986df414989b5a1
parentf5b9b1c8632de9f2066bc45ded336d1e04e64aab (diff)
Document input options for the browser
-rw-r--r--README.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/README.md b/README.md
index df4f2da..354f66d 100644
--- a/README.md
+++ b/README.md
@@ -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: