@takumi-rs/helpers 1.0.8 → 1.0.10

package/README.md

@@ -1,5 +1,60 @@
 # @takumi-rs/helpers
 
-Helper package for constructing Takumi layout.
+**Utility functions and types for working with Takumi node trees.**
 
-Checkout [documentation](https://takumi.kane.tw/docs/deep-dives/from-jsx-helper) for usage.
+This package provides the core logic for converting JSX and HTML into the layout-ready node trees that Takumi's Rust engine expects. It also handles resource fetching (fonts, images) and emoji processing.
+
+[Documentation](https://takumi.kane.tw/docs/architecture#fromjsx-helper) · [GitHub](https://github.com/kane50613/takumi)
+
+## Installation
+
+```bash
+npm install @takumi-rs/helpers
+```
+
+## Features
+
+### JSX to Node Tree
+
+Convert React-like elements into a serializable node tree + stylesheets.
+
+```tsx
+import { fromJsx } from "@takumi-rs/helpers/jsx";
+
+const { node, stylesheets } = await fromJsx(<div style={{ display: "flex" }}>Hello</div>);
+```
+
+### HTML to Node Tree
+
+Parse HTML strings into Takumi nodes.
+
+```ts
+import { fromHtml } from "@takumi-rs/helpers/html";
+
+const { node, stylesheets } = await fromHtml("<div style='color: red'>Hello</div>");
+```
+
+### Resource Fetching
+
+Extract and fetch external resources (images, fonts) mentioned in a node tree.
+
+```ts
+import { extractResourceUrls, fetchResources } from "@takumi-rs/helpers";
+
+const urls = extractResourceUrls(node);
+const resources = await fetchResources(urls);
+```
+
+### Emoji Processing
+
+Find and replace emoji characters in text nodes with image nodes (Twemoji or custom).
+
+```ts
+import { extractEmojis } from "@takumi-rs/helpers/emoji";
+
+const newNode = extractEmojis(oldNode, "twemoji");
+```
+
+## License
+
+MIT or Apache-2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@takumi-rs/helpers",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "license": "(MIT OR Apache-2.0)",
   "author": {
     "name": "Kane Wang",