Added typedocs

.github/workflows/typedoc.yml

@@ -0,0 +1,31 @@
+name: Build and Deploy TypeDoc
+
+on:
+  push:
+    branches:
+      - main  # Triggers the workflow on pushes to the main branch
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Set up Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: '20' 
+
+    - name: Install dependencies
+      run: npm install
+
+    - name: Build documentation with TypeDoc
+      run: npm run docgen
+
+    - name: Deploy to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs  # Directory containing TypeDoc output

.gitignore

@@ -1,2 +1,3 @@
 node_modules
 dist
+docs

.prettierrc.json

@@ -2,5 +2,5 @@
   "trailingComma": "es5",
   "tabWidth": 2,
   "semi": true,
-  "printWidth": 120,
+  "printWidth": 120
 }

README.md

@@ -1,3 +1,30 @@
 # Dapp Kit
 
 Common utilities for building decentralized applications.
+
+## Docs
+
+http://papercliplabs.github.io/dapp-kit
+
+## Installation in another project
+
+```bash
+pnpm install @paperclip-labs/dapp-kit
+```
+
+## Module Development
+
+Install Dependencies
+```bash
+pnpm i
+```
+
+Build
+```bash
+pnpm build
+```
+
+Generate docs
+```bash
+pnpm docgen
+```

package.json

@@ -20,14 +20,16 @@
     }
   },
   "scripts": {
-    "build": "tsc"
+    "build": "tsc",
+    "docgen": "typedoc"
   },
   "keywords": [],
   "author": "Paperclip Labs",
   "license": "MIT",
   "devDependencies": {
     "@types/react": "^18.3.11",
     "prettier": "^3.3.3",
+    "typedoc": "^0.26.10",
     "typescript": "^5.6.3"
   },
   "dependencies": {