aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2014-03-18 16:21:12 +0000
committerMichael Williamson <mike@zwobble.org>2014-03-18 16:21:12 +0000
commit8c78bde5725c3442f3b5c9a470615a2fde902e5b (patch)
treef330c80ae2c20fefb9966ded43e9db0809520ee0
parente251ae2c3e56636e41ab178be0a924abda7e7eee (diff)
Add CLI to README.md
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index b20eb01..ca83f13 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,15 @@ You can start it up by running `node lib/web.js` from the project directory.
Browserify can be used to run Mammoth in the browser.
To see an example, run `make setup` and open `browser-demo/index.html` in a web browser.
+
+### CLI
+
+You can convert docx files by passing the path to the docx file and the output file.
+For instance:
+
+ mammoth document.docx output.html
+
+If no output file is specified, output is written to stdout instead.
### Library