ironmark 1.6.0 → 1.7.0

package/README.md

@@ -144,10 +144,60 @@ Exported AST types:
 - `TableData`
 - `TableAlignment`
 
+## C / C++
+
+The crate compiles to a static library (`libironmark.a`) that exposes two C functions. A header is provided at `include/ironmark.h`.
+
+### Build the library
+
+```bash
+cargo build --release
+# output: target/release/libironmark.a
+```
+
+### Link
+
+```sh
+# Linux
+cc -o example example.c -L target/release -l ironmark -lpthread -ldl
+
+# macOS
+cc -o example example.c -L target/release -l ironmark \
+   -framework CoreFoundation -framework Security
+```
+
+### Usage
+
+```c
+#include "include/ironmark.h"
+#include <stdio.h>
+
+int main(void) {
+    char *html = ironmark_parse("# Hello\n\nThis is **fast**.");
+    if (html) {
+        printf("%s\n", html);
+        ironmark_free(html);
+    }
+    return 0;
+}
+```
+
+**Memory contract**: `ironmark_parse` returns a heap-allocated string. You **must** free it with `ironmark_free`. Passing any other pointer to `ironmark_free` is undefined behaviour. Both functions are null-safe: `ironmark_parse(NULL)` returns `NULL`; `ironmark_free(NULL)` is a no-op.
+
+Parsing always uses the default `ParseOptions` (all extensions enabled, `disable_raw_html` off). Options are not yet configurable through the C API.
+
 ## Benchmarks
 
 ![Benchmark results](benchmark/results.svg)
 
+Compares ironmark against pulldown-cmark, comrak, markdown-it, and markdown-rs. Results are also saved as `benchmark/results.csv`.
+
+```bash
+cargo bench                          # run all benchmarks
+cargo bench --features bench-md4c   # include md4c (requires: brew install md4c)
+pnpm bench                          # run + regenerate SVG report
+```
+
 ## Development
 
 This project uses [pnpm](https://pnpm.io/) for package management.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ironmark",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Very fast markdown parser in Rust, consumable from JavaScript/TypeScript via WebAssembly",
   "keywords": [
     "markdown",
@@ -59,6 +59,7 @@
     "release:dry": "semantic-release --dry-run",
     "setup:wasm": "PATH=\"$HOME/.cargo/bin:$PATH\" rustup target add wasm32-unknown-unknown && TMPDIR=/tmp PATH=\"$HOME/.cargo/bin:$PATH\" cargo install wasm-bindgen-cli --version 0.2.114 --locked --root .wasm-tools",
     "bench": "cargo bench && node benchmark/report.mjs",
+    "bench:full": "cargo bench --features bench-md4c && node benchmark/report.mjs",
     "test": "cargo test --offline"
   },
   "devDependencies": {