Add README and API docs

2026-01-26 19:20:54 +07:00
parent 713efb81b5
commit bc5eea7841
9 changed files with 510 additions and 3 deletions
--- a/package.json
+++ b/package.json
@@ -10,8 +10,9 @@
  ],
  "scripts": {
    "build": "rimraf dist && tsc",
+    "doc": "typedoc",
    "test": "echo \"Error: no test specified\" && exit 1",
-    "version": "pnpm run build && git add dist"
+    "version": "pnpm run build && pnpm run doc && git add dist docs README.md"
  },
  "author": "Râu Cao <raucao@kosmos.org>",
  "license": "MIT",
@@ -19,6 +20,8 @@
    "json-schema-to-ts": "^3.1.1",
    "remotestoragejs": "^2.0.0-beta.8",
    "rimraf": "^6.1.2",
+    "typedoc": "^0.28.16",
+    "typedoc-plugin-markdown": "^4.9.0",
    "typescript": "^5.9.3"
  },
  "dependencies": {