From 2230d84fb42f0ce4e3a5db9b346718b1411ed5a3 Mon Sep 17 00:00:00 2001
From: Michael Williamson <mike@zwobble.org>
Date: Sun, 8 Feb 2015 21:29:39 +0000
Subject: Add markdown support to README.md

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index 1409360..9d08a38 100644
--- a/README.md
+++ b/README.md
@@ -74,6 +74,16 @@ Where `custom-style-map` looks something like:
     p[style-name='Aside Heading'] => div.aside > h2:fresh
     p[style-name='Aside Text'] => div.aside > p:fresh
 
+#### Markdown
+
+Using `--output-format=markdown` will cause Markdown to be generated.
+For instance:
+
+    mammoth document.docx --output-format=markdown
+
+Markdown support is still in its early stages,
+so you may find some features are unsupported.
+
 ### Library
 
 #### Basic conversion
@@ -194,6 +204,12 @@ Converts the source document to HTML.
 
   * `messages`: any messages, such as errors and warnings, generated during the conversion
 
+#### `mammoth.convert_to_markdown(*args, **kwargs)`
+
+Converts the source document to Markdown.
+This behaves the same as `convert_to_html`,
+except that the `value` property of the result contains Markdown rather than HTML.
+
 #### `mammoth.extract_raw_text(fileobj)`
 
 Extract the raw text of the document.
-- 
cgit v1.2.3