readme

README.md

@@ -2,33 +2,44 @@
 
 [![JSR](https://jsr.io/badges/@dbushell/hyperless?labelColor=98e6c8&color=333)](https://jsr.io/@dbushell/hyperless) [![NPM](https://img.shields.io/npm/v/@dbushell/hyperless?labelColor=98e6c8&color=333)](https://www.npmjs.com/package/@dbushell/hyperless)
 
-Remove the “H” from HTML. Hyperless is a lightweight library for converting HTML to plain text quickly. It removes the “ML” too I guess... HTML to text and other useful stuff. That’s the idea.
+HTML parser and various utilities.
 
-## Functions
+## `parseHTML`
 
-### `stripTags`
-
-Remove HTML and return text content with a few niceties.
+Parse an HTML document or fragment into a traversable node tree.
 
 ```javascript
-import {stripTags} from '@dbushell/hyperless';
-// Pass a chunk of HTML
-const text = stripTags('<p>Ceci n’est pas une paragraphe.</p>');
+import {parseHTML} from '@dbushell/hyperless';
+const root = parseHTML('<h1>Hello, World!</h1>');
 ```
 
-Text in `<blockquote>` and `<q>` are wrapped in quotation marks.
+Node API subject to change.
 
-### `parseAttributes`
+## `parseAttributes`
 
 Parse an HTML attribute string into a case-insensitive deduplicated key/value map.
 
 ```javascript
 import {parseAttributes} from '@dbushell/hyperless';
-const map = parseAttributes('a="1" b="2" c d="d" D="d"');
+const map = parseAttributes('a="1" b="2" c d="d" D="d" e=e');
 ```
 
 HTML entity encoding is handled automatically by default.
 
+## Utilities
+
+### `stripTags`
+
+Remove HTML and return text content with a few niceties.
+
+```javascript
+import {stripTags} from '@dbushell/hyperless';
+// Pass a chunk of HTML
+const text = stripTags('<p>Ceci n’est pas une paragraphe.</p>');
+```
+
+Text in `<blockquote>` and `<q>` are wrapped in quotation marks.
+
 ### `excerpt`
 
 Generate a text excerpt from HTML content.

deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@dbushell/hyperless",
-  "version": "0.18.0",
+  "version": "0.19.0",
   "exports": {
     ".": "./mod.ts"
   },

package.json

@@ -1,11 +1,11 @@
 {
   "name": "@dbushell/hyperless",
-  "version": "0.18.0",
+  "version": "0.19.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/dbushell/hyperless.git"
   },
-  "description": "HTML to text and other useful stuff.",
+  "description": "HTML parser and various utilities.",
   "keywords": [
     "html",
     "typescript"