Skip to content

Commit c196005

Browse files
committed
docs: update README with V2 features and documentation links
1 parent 8d2c340 commit c196005

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,26 @@ High-precision share calculations ensure accurate distribution across all recipi
1717
## Architecture
1818

1919
- **Core Pool Logic**: Dynamic recipient configurations with percentage/unit-based shares
20+
- **Bucket Semantics**: Structured categorization (TEAM, INVESTORS, TREASURY, etc.)
21+
- **Source Tracking**: Revenue attribution (Base Pay, protocol fees, grants, etc.)
2022
- **Registry**: Centralized pool management and discovery
2123
- **Executor**: Base Pay integration for automated execution flows
2224
- **Upgradeability**: UUPS proxy pattern with static addresses
2325

26+
**📚 Documentation:**
27+
- [Architecture Guide](./docs/ARCHITECTURE.md) - Technical architecture and integration patterns
28+
- [Domain Model](./docs/DOMAIN_MODEL.md) - Business concepts explained for non-developers
29+
2430
## Features
2531

2632
- Create and manage payout pools with flexible share models
33+
- **Bucket categorization** (TEAM, INVESTORS, TREASURY, REFERRALS, SECURITY_FUND, GRANTS)
34+
- **Revenue source tracking** (Base Pay, protocol fees, grants, donations, partnerships)
35+
- **Distribution history** with full on-chain audit trail
2736
- Execute distribution cycles with precise accounting
2837
- Support for Base smart wallets and sub-accounts
29-
- Full upgradeability without address changes
30-
- Event emissions optimized for Subgraph indexing
38+
- Full upgradeability without address changes (V1 → V2 compatible)
39+
- Event emissions optimized for Subgraph indexing and analytics dashboards
3140
- Gas-optimized execution for cost-effective operations
3241

3342
## Development

0 commit comments

Comments
 (0)