summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2014-03-17 18:43:16 +0000
committerMichael Williamson <mike@zwobble.org>2014-03-17 18:43:16 +0000
commit402125e641eec86ad771caa4b5ad9db657e5fcd9 (patch)
treed690d11113132e7388dca7f08960cef7e4d47870
parente4dd30342017bfa0fabec653add92a8e2188f13c (diff)
Add note that convertToHtml returns a promise
-rw-r--r--README.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/README.md b/README.md
index 354f66d..b20eb01 100644
--- a/README.md
+++ b/README.md
@@ -44,6 +44,8 @@ mammoth.convertToHtml({path: "path/to/document.docx"})
.done();
```
+Note that `mammoth.convertToHtml` returns a [promise](http://promises-aplus.github.io/promises-spec/).
+
### Custom style map
By default,