Document all of our new features

iarna · iarna · commit a03270f23d51 · 2018-07-07T16:28:37.000-07:00
diff --git a/README.md b/README.md
@@ -48,3 +48,88 @@ Supported features:
 * Paragraph first-line indents (as `text-indent: #pt`)
 * Idented regions (as `padding-left: #pt`)
 * Text alignment: left, right, center, justify (as `text-align:`)
+
+## rtfToHTML([opts], cb) → WritableStream
+
+* opts - Optional options to pass to the HTML generator. See the section on [Options](#options) for details.
+* cb - A callback accepting `(err, html)`, see the section on the [Callback](#callback) for details.
+
+Returns a WritableStream that you can pipe into.
+
+## rtfToHTML.fromStream(stream[, opts], cb)
+
+* stream - A readable stream that should contain RTF.
+* opts - Optional options to pass to the HTML generator. See the section on [Options](#options) for details.
+* cb - A callback accepting `(err, html)`, see the section on the [Callback](#callback) for details.
+
+## rtfToHTML.fromString(string[, opts], cb)
+
+* string - A string containing RTF.
+* opts - Optional options to pass to the HTML generator. See the section on [Options](#options) for details.
+* cb - A callback accepting `(err, html)`, see the section on the [Callback](#callback) for details.
+
+## Callback
+
+<a name="callback">
+rtfToHTML returns HTML produced from RTF using a standard Node.js style
+callback, which should accept the following arguments: `(err, html)`.
+
+If we encounter an error in parsing then it will be set in `err`.  Otherwise
+the resulting HTML will be in `html`.
+
+## Options
+
+<a name="options">
+Options are always optional. You can configure how HTML is generated with the following:
+
+* paraBreaks - (Defaults to `\n\n`) Inserted between resulting paragraphs.
+* paraTag - (Defaults to `p`) The tagname to use for paragraphs.
+* template - A function that is used to generate the final HTML document, defaults to:
+  ```js
+  function outputTemplate (doc, defaults, content) {
+    return `<!DOCTYPE html>
+  <html>
+    <head>
+      <meta charset="UTF-8">
+      <style>
+      body {
+        margin-left: ${doc.marginLeft / 20}pt;
+        margin-right: ${doc.marginRight / 20}pt;
+        margin-top: ${doc.marginTop / 20}pt;
+        margin-bottom: ${doc.marginBottom / 20}pt;
+        font-size: ${defaults.fontSize / 2}pt;
+        text-indent: ${defaults.firstLineIndent / 20}pt;
+      }
+      </style>
+    </head>
+    <body>
+      ${content.replace(/\n/, '\n    ')}
+    </body>
+  </html>`
+  }
+  ```
+
+You can also configure some of the starting (default) state of the output formatting with:
+
+* disableFonts - Defaults to `true`. If you set this to `false` then we'll output font change information when we encounter it. This is
+  a bit broken due to our not supporting styles.
+* fontSize - Defaults to the document-wide declared font size, or if that's missing, `24`.
+* bold - Defaults to `false`
+* italic - Defaults to `false`
+* underline - Defaults to `false`
+* strikethrough - Defaults to `false`
+* foreground - Defaults to `{red: 0, blue: 0, green: 0}`
+* background - Defaults to `{red: 255, blue: 255, green: 255}`
+* firstLineIndent - Defaults to the document-wide value, or if that's missing, `0`. This is how far to indent the first line of new paragraphs.
+* indent: Defaults to `0`
+* align: Defaults to `left`.
+* valign: Defaults to `normal`
+
+## const rtfToHTML = require('rtf-to-html/rtf-to-html.js')
+## rtfToHTML(doc[, opts]) → HTML
+
+This is internally how the other interfaces are implemented.  Unlike the
+other interfaces, this one is synchronous.
+
+* doc - A parsed RTF document as produced by the `rtf-parser` library.
+* opts - Optional options, see the section on [Options](#options) for details.
