Skip to content

Commit 539e888

Browse files
committed
Better documentation for developers
1 parent fdf3d38 commit 539e888

3 files changed

Lines changed: 388 additions & 0 deletions

File tree

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ The purpose of TAIPs is to provide the community with a means to propose enhance
1111
## Documentation
1212

1313
- [Message Types and Data Structures](./messages.md) - Comprehensive documentation of all TAP message types and data structures
14+
- [Developer Resources](./developers.md) - Quick start guide for developers with examples and usage instructions
15+
- [JSON Schemas](./schemas/) - Machine-readable JSON Schema definitions for all TAP messages
16+
- [TypeScript Types](./packages/typescript/) - TypeScript type definitions (`@taprsvp/types` npm package)
1417

1518
## TAIP Statuses
1619

@@ -36,6 +39,32 @@ The purpose of TAIPs is to provide the community with a means to propose enhance
3639
| 12 | [Hashed Participant Name sharing in TAP messages](./TAIPs/taip-12.md) |
3740
| 13 | [Transaction Purpose Codes](./TAIPs/taip-13.md) |
3841
| 14 | [Payment Requests](./TAIPs/taip-14.md) |
42+
| 15 | [Agent Connection Protocol](./TAIPs/taip-15.md) |
43+
| 16 | [Invoices](./TAIPs/taip-16.md) |
44+
45+
## Implementation Resources
46+
47+
### JSON Schemas
48+
All TAP message types have corresponding JSON Schema definitions available at:
49+
- **Base URL**: https://taips.tap.rsvp/schemas/
50+
- **Local Path**: [./schemas/](./schemas/)
51+
52+
Example schemas:
53+
- Transfer Message: https://taips.tap.rsvp/schemas/messages/transfer.json
54+
- Payment Message: https://taips.tap.rsvp/schemas/messages/payment.json
55+
- Party Structure: https://taips.tap.rsvp/schemas/data-structures/party.json
56+
57+
### TypeScript Types
58+
Official TypeScript type definitions are available as an npm package:
59+
- **Package**: `@taprsvp/types`
60+
- **Source**: [./packages/typescript/](./packages/typescript/)
61+
- **Installation**: `npm install @taprsvp/types`
62+
63+
The package exports:
64+
- All TAP message type interfaces
65+
- Data structure types (Party, Agent, Policy, etc.)
66+
- Common types (CAIP identifiers, ISO types, etc.)
67+
- Full TypeScript support with comprehensive JSDoc comments
3968

4069
## Inspiration
4170

_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ header_pages:
3030
- index.html
3131
- tap-overview.md
3232
- messages.md
33+
- developers.md
3334

3435
# Build settings
3536
markdown: kramdown

0 commit comments

Comments
 (0)