Skip to content

[Docs] Polish plotlink-contracts README.md #447

@realproject7

Description

@realproject7

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

  • README matches quality/structure of Mint Club V2 repo
  • Mainnet deployed addresses listed
  • Build/test/deploy instructions work
  • Clean, professional presentation

Branch

task/447-readme-polish in plotlink-contracts repo

Metadata

Metadata

Assignees

No one assigned

    Labels

    agent/T3Assigned to T3 builder agent

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions