📝 add some docs

README.md

@@ -9,14 +9,14 @@ While designed around the [EditorJS](https://github.com/codex-team/editor.js) AP
 The conversion from HTML can be done as follows:
 
 ```ts
-import { convertHtmlToBlocks } from "@sftsrv/structured-html";
+import { convertHtmlToStructuredContents } from "@sftsrv/structured-html";
 
 // get some RAW HTML
 const htmlText = "<p>hello world</p>";
 
 // use the DOM to parse it from a string
 const html = new DOMParser().parseFromString(htmlText, "text/html").body;
 
-// the convertHtmlToBlocks function takes an HTML ELement and returns the structured HTML content
-const blocks = convertHtmlToBlocks(html);
+// the convertHtmlToStructuredContents function takes an HTML ELement and returns the structured HTML content
+const blocks = convertHtmlToStructuredContents(html);
 ```

jsr.json

@@ -1,5 +1,8 @@
 {
   "name": "@sftsrv/structured-html",
-  "version": "0.0.1",
-  "exports": "./src/index.ts"
+  "version": "0.0.2",
+  "exports": {
+    ".": "./src/index.ts",
+    "blocks": "./src/blocks.ts"
+  }
 }

src/index.ts

@@ -184,7 +184,15 @@ const tagHandlers: TagHandlerMap = {
   H6: headingHandler(6),
 };
 
-export const convertHtmlToBlocks = (html: Element): EditorContent => {
+/**
+ * Converts HTML to structured content
+ *
+ * @param html input HTML
+ * @returns the restructured and simplified HTML
+ */
+export const convertHtmlToStructuredContents = (
+  html: Element
+): EditorContent => {
   const transformed = transform(html);
 
   const baseHandler = tagHandlers[transformed.tagName];