docs: update

antfu · Jan 22, 2025 · ffb41ee · ffb41ee
1 parent 7483637
commit ffb41ee
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -8,6 +8,8 @@
 
 Enhance [`markdown-it`](https://github.com/markdown-it/markdown-it) to support **async** highlight function.
 
+This package is a wrapper on top of `markdown-it` instead of a fork. Updates from `markdown-it` will be reflected without as transient dependencies.
+
 ## Usage
 
 ```ts
@@ -20,6 +22,7 @@ const md = MarkdownItAsync({
   }
 })
 
+// Note you need to use `renderAsync` instead of `render`
 const html = await md.renderAsync(markdown)
 ```