Skip to content

docs: improve README with badges and better formatting #33

@jose-compu

Description

@jose-compu

Polish

The README could use more badges to signal project maturity. Currently I think we only have the basics. Would be good to add:

  • CI status badge (from GitHub Actions)
  • Coverage badge (once we set that up — see the coverage issue)
  • npm version badge
  • License badge
  • Solidity version badge
  • Maybe a "PRs Welcome" badge

Also the installation section could be cleaner — right now it mixes Foundry, Hardhat, and npm instructions which is good but the formatting is a bit cramped. Some spacing and maybe subsection headers would help readability.

Small visual polish but it makes a real difference for first impressions.

Metadata

Metadata

Assignees

No one assigned

    Labels

    cleanupCode cleanup and dead code removaldocumentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions