Skip to content

Commit 1dbe57f

Browse files
authored
feat: typedoc (#13)
1 parent 76b135a commit 1dbe57f

File tree

7 files changed

+270
-2
lines changed

7 files changed

+270
-2
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
node_modules/
22
dist/
3+
docs/
34
*.tsbuildinfo
45
.env
56
.env.local

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ npm run dev # Watch mode for TypeScript
1414
npm run lint # Type-check without emitting (tsc --noEmit)
1515
npm test # Run tests with vitest
1616
npm run test:watch # Run tests in watch mode
17+
npm run docs # Generate API documentation with TypeDoc
1718
```
1819

1920
## Architecture

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,19 @@ npm run dev # Watch mode for TypeScript
1818
npm run lint # Type-check without emitting
1919
npm test # Run tests
2020
npm run test:watch # Run tests in watch mode
21+
npm run docs # Generate API documentation
2122
```
2223

24+
## API Documentation
25+
26+
Generate API reference documentation locally:
27+
28+
```bash
29+
npm run docs
30+
```
31+
32+
Documentation will be generated in the `docs/` directory. Open `docs/index.html` in a browser to view.
33+
2334
## Quick Start
2435

2536
### With Any Wallet (cosmos-kit, Web3Auth, etc.)

package-lock.json

Lines changed: 233 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)