Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ije authored Jul 17, 2024
1 parent 8036174 commit 9fd2a40
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# md4w

A **Markdown** renderer written in Zig & C, compiled to **WebAssymbly** for all
JS runtimes.
A **Markdown** renderer written in Zig & C, compiled to **WebAssymbly**.

- **Compliance**: powered by [md4c](https://github.com/mity/md4c) that is fully
compliant to CommonMark 0.31, and partially supports GFM like task list,
Expand All @@ -10,7 +9,7 @@ JS runtimes.
than markdown-it, see [benchmark](#benchmark)).
- **Small**: `~28KB` gzipped.
- **Simple**: zero dependencies, easy to use.
- **Streaming**: supports web streaming API for large markdown files.
- **Streaming**: supports web streaming API for reducing memory usage.
- **Universal**: works in any JavaScript runtime (Node.js, Deno, Bun, Browsers,
Cloudflare Workers, etc).

Expand Down Expand Up @@ -149,7 +148,7 @@ setCodeHighlighter((code, lang) => {

## Web Streaming API

md4w supports web streaming API for large markdown files, this also is useful
md4w provides the web streaming API, that is useful
for a http server to stream the outputed html.

```js
Expand Down

0 comments on commit 9fd2a40

Please sign in to comment.