aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2014-07-06 17:46:21 +0100
committerMichael Williamson <mike@zwobble.org>2014-07-06 17:46:21 +0100
commit42161df2673dd9d649e31dd0cc265738300af771 (patch)
treecd475acebf15a748d7c5809afe7c1a91c3f63b46 /README.md
parent93d5aae9e51066cc37b80658055fe96666564338 (diff)
Add supported features to README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8690e3e..c09aea9 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,23 @@ There's a large mismatch between the structure used by .docx and the structure o
meaning that the conversion is unlikely to be perfect for more complicated documents.
Mammoth works best if you only use styles to semantically mark up your document.
+The following features are currently supported:
+
+* Headings.
+
+* Lists.
+
+* Customisable mapping from your own docx styles to HTML.
+ For instance, you could convert `WarningHeading` to `h1.warning` by providing an appropriate style mapping.
+
+* Tables.
+ The formatting of the table itself, such as borders, is currently ignored,
+ but the formatting of the text is treated the same as in the rest of the document.
+
+* Images.
+
+* Bold and italics.
+
## Installation
pip install mammoth