Summary
Polish the README.md for the plotlink-contracts repo. Benchmark against the Mint Club V2 contracts repo: https://github.com/Steemhunt/mint.club-v2-contract
Reference
Use the Mint Club V2 repo README structure as the template:
- Project overview / what it does
- Contract architecture diagram or table
- Deployed addresses (mainnet only)
- Build / test / deploy instructions
- License
Deployed Contracts (Base Mainnet only)
| Contract |
Address |
Purpose |
| StoryFactory |
0xfa5489b6710Ba2f8406b37fA8f8c3018e51FA229 |
Storyline + plot management |
| ZapPlotLinkV2 |
0x04f557F8D2806B34FC832a534c08DF514D4dfEeF |
Multi-token zap (ETH/USDC/HUNT → PLOT → storyline token) |
Include
- Project description (on-chain storytelling protocol, bonding curves, royalties)
- How StoryFactory works (createStoryline, chainPlot, donate)
- How ZapPlotLinkV2 works (routing: ETH via Uniswap V4, HUNT via MCV2, USDC via WETH multi-hop)
- Deployed addresses table (Base mainnet only — no testnet)
- External dependencies (MCV2_Bond, Uniswap V4, ERC-8004)
- Build:
forge build, Test: forge test, Deploy scripts
- License
Acceptance Criteria
Branch
task/447-readme-polish in plotlink-contracts repo
Summary
Polish the README.md for the
plotlink-contractsrepo. Benchmark against the Mint Club V2 contracts repo: https://github.com/Steemhunt/mint.club-v2-contractReference
Use the Mint Club V2 repo README structure as the template:
Deployed Contracts (Base Mainnet only)
0xfa5489b6710Ba2f8406b37fA8f8c3018e51FA2290x04f557F8D2806B34FC832a534c08DF514D4dfEeFInclude
forge build, Test:forge test, Deploy scriptsAcceptance Criteria
Branch
task/447-readme-polishin plotlink-contracts repo