Add async flag to the readme

Signed-off-by: Michael Irwin <[email protected]>
remarkjs · Apr 6, 2022 · bc044a7 · bc044a7
1 parent 1d04e4a
commit bc044a7
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/readme.md b/readme.md
@@ -211,6 +211,9 @@ The default export is `ReactMarkdown`.
 *   `transformImageUri` (`(src, alt, title) => string`, default:
     [`uriTransformer`][uri-transformer], optional)\
     change URLs on images, pass `null` to allow all URLs, see [security][]
+*   `async` (`boolean`, default: `false`)\
+    change processing to support plugins that run asynchronously.  Note that
+    async usage may break server-side rendering.
 
 ### `uriTransformer`