fix documentation

NMyVision · Jan 3, 2025 · 4307ad8 · 4307ad8
1 parent eb6f478
commit 4307ad8
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -5,9 +5,11 @@
 ```
 
 ```js
+import { HtmlParser } from "@nmyvision/html-parser";
+
 const hp = new HtmlParser();
 
-let result = hp.Parse("<div><input disabled required type='text' /></div>");
+let result = hp.parse("<div><input disabled required type='text' /></div>");
 ```
 
 ![Screenshot](docs/output-screenshot.png)
diff --git a/src/HtmlParser.ts b/src/HtmlParser.ts
@@ -34,6 +34,12 @@ export class HtmlParser {
     this.q = new StringQueue();
   }
 
+  /**
+   * This function parses the html string and returns a list of nodes.
+   *
+   * @param source the html string to be parsed
+   * @returns HTMLNode[]
+   */
   public parse(source: string): HtmlNode[] {
     this.source = source;
     this.q = new StringQueue(source);