Lint and generate docs

Author: PythonCoderAS

.gitignore

@@ -102,3 +102,5 @@ dist
 
 # TernJS port file
 .tern-port
+
+docs

.prettierignore

@@ -1 +1,2 @@
 /dist
+/docs

README.md

@@ -1,12 +1,19 @@
-# typescript-project-template
+# bbcode-ast
 
-Template repo for new TypeScript projects.
+Generates an Abstract Syntax Tree (AST) from a chunk of BBCode.
 
-This repo assumes the following:
+## Installation
 
-- Source code lives in the `src` directory.
-- The main export is located in `src/index.ts`.
-- Tests live in the `test` directory.
-- Each test is name `<name>.test.ts`.
-- The `npm_token`, `app_id`, and `app_private_key` secrets are present in the repo.
-- The code will be a CommonJS module.
+```bash
+npm install --save bbcode-ast
+```
+
+## Usage
+
+You can either use the default parser or construct your own parser. Once you have a `Parser`, call the `parse` method on
+it.
+
+It will return the root node of the AST.
+
+You can navigate through the tree by accessing the `children` attribute of the root node and recursively inspecting
+the `children` of child nodes.

package-lock.json

@@ -32,6 +32,7 @@
     "mocha": "^10.0.0",
     "prettier": "^2.7.1",
     "ts-node": "^10.9.1",
+    "typedoc": "^0.23.10",
     "typescript": "^4.7.4"
   }
 }

package.json

@@ -21,5 +21,8 @@ const defaultTags = [
   "code",
   "quote",
 ];
+/**
+ * The default BBcode parser. Implements the tags used on the website [MyAnimeList](https://myanimelist.net/info.php?go=bbcode).
+ */
 const defaultParser = new Parser(defaultTags, false);
 export default defaultParser;