html2any 0.1.1 → 0.2.0

package/README.md

@@ -2,27 +2,29 @@
 
 [![npm version](https://badge.fury.io/js/html2any.svg)](https://badge.fury.io/js/html2any)
 
-> A non-dependecy package for coverting html/xml string to your customized format/structures.
+> Compile messy HTML into compact context for AI agents.
 
-While building websites, people may met issues for rendering rich text into different formats.
+## Library
+
+While building websites, people may need to render rich text into different formats.
 For example, I've got an `<video>` tag, but I wanna render it with my own React video component.
 But I also want to render the whole html easily rather than parse it manually.
 
-Now `html2any` help you to render html string. It not only parses your html but also gives you ability to transform it from origin to the dest.
+`html2any` helps you render an HTML string. It parses HTML and gives you the ability to transform it from the source format into your target format.
 
 ### API
 
-html2any provide following APIs
+html2any provides the following APIs:
 
 - `AST(Object) parse(String source)`
 - `void transform(AST ast, function rule)`
 - `void html2any(html, function rule)`
 
 - parse
-> Build the AST from source to AST from source html/xml code
+> Build an AST from HTML/XML source.
 
 - transform
-> Convert the AST to the final form with the specific rule.
+> Convert the AST to a final form with a custom rule.
 
 - html2any
 > Convert the html/xml to the final form directly.
@@ -60,9 +62,30 @@ Or you can just call html2any directly
 const vdom = html2any(html, rule)
 ```
 
-### How It Works
+### CLI
+
+Convert a local file, URL, or stdin into compact Markdown:
+
+```bash
+html2any md <file|url|->
+
+# Short alias
+html2 md <file|url|->
+```
 
-Use `html2any` to construct an AST of html string, then convert each node recursively with `rule` passed to transform function.
+Examples:
+
+```bash
+html2 md page.html > page.context.md
+cat page.html | html2 md - --url https://example.com/page
+```
+
+The Markdown output keeps docs-friendly structure: title, description, headings, paragraphs, lists, tables, code blocks, and links.
+
+The extractor is deterministic and token-size friendly. It drops scripts, styles, hidden content, and layout chrome while preserving semantically useful docs content.
+
+### How It Works
 
-For example, we translate `<p>` tag into React Native component `<Text style={styles.paragraph}>` with the prepared styles. Then decode the p tag' s content to avoid html entities mess up.
+Use `html2any` to construct an AST from an HTML string, then convert each node recursively with the `rule` passed to the transform function.
 
+For example, translate a `<p>` tag into a React Native component like `<Text style={styles.paragraph}>` with prepared styles, then decode the paragraph content to avoid HTML entity issues.