wip

.github/workflows/gh-pages.yml

@@ -33,11 +33,11 @@ jobs:
       - name: Install
         run: npm install
       - name: Build
-        run: npm run build-example
+        run: npm run build-docs
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: public/
+          path: docs
 
   # Deployment job
   deploy:

.gitignore

@@ -6,3 +6,4 @@ src/*.js
 dist
 .env
 public
+docs

README.md

@@ -1,5 +1,7 @@
 # ailuropoda
 
+![tests](https://github.com/bicycle-codes/ailuropoda/actions/workflows/nodejs.yml/badge.svg)
+
 Implementing [bamboo](https://github.com/AljoschaMeyer/bamboo), using only browser compatible cryptography.
 
 ## install

package.json

@@ -15,8 +15,8 @@
     "build-cjs": "esbuild src/*.ts --format=cjs --keep-names --tsconfig=tsconfig.build.json --outdir=./dist --out-extension:.js=.cjs --sourcemap=inline",
     "build-esm": "tsc --project tsconfig.build.json",
     "build-example": "mkdir -p ./public && rm -rf ./public/* && vite build --base=./",
+    "build-docs": "typedoc ./src/index.ts",
     "build": "mkdir -p ./dist && rm -rf ./dist/* && npm run build-cjs && npm run build-esm",
-    "start": "vite",
     "preversion": "npm run lint",
     "version": "auto-changelog -p --template keepachangelog --breaking-pattern 'BREAKING CHANGE:' && git add CHANGELOG.md",
     "postversion": "git push --follow-tags && npm publish",
@@ -29,13 +29,10 @@
     "@oddjs/odd": "^0.37.2",
     "json-canon": "^1.0.1",
     "monotonic-timestamp": "^0.0.9",
-    "p2panda-js": "^0.8.1",
     "uint8arrays": "^5.0.3"
   },
   "devDependencies": {
     "@bicycle-codes/tapzero": "^0.9.2",
-    "@nichoth/debug": "^0.6.7",
-    "@preact/preset-vite": "^2.8.2",
     "@ssc-half-light/node-components": "^0.1.22",
     "@typescript-eslint/eslint-plugin": "^7.6.0",
     "@typescript-eslint/parser": "^7.6.0",
@@ -47,8 +44,8 @@
     "preact": "^10.20.2",
     "tap-spec": "^5.0.0",
     "tape-run": "^11.0.0",
-    "typescript": "^5.4.4",
-    "vite": "^5.2.10"
+    "typedoc": "^0.25.13",
+    "typescript": "^5.4.4"
   },
   "exports": {
     ".": {