Skip to content

README: refresh project map and structure for SDK + 3-contract era #150

Description

@samjay8

Context

The README's project structure and badges were written before the SDK package and the 3-contract architecture; a new visitor cannot quickly tell what ships where.

Task

Update the README "Project structure" section to include apps/sdk, reflect the current badge set (CI, contributors, license), and add a short "Project map" paragraph linking the monorepo and the contracts repo (mirroring the same section on the contracts README).

Stop

Do not describe features as shipped that are not merged. Do not reintroduce removed content (per the earlier label/docs cleanup).

Acceptance

  • README accurately reflects the current two-repo, SDK + 3-contract structure.
  • The project-map paragraph cross-links both repos.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation improvementsgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions