Skip to content

Extend README with usage examples & explanation of limitations #508

@casks-mutters

Description

@casks-mutters

The README is relatively minimal: it outlines quickstart and conceptual overview.
It would benefit from more detailed usage examples and a “Limitations / Caveats” section. For example:

  • Example commands comparing two blocks on Mainnet, or on an L2 (Arbitrum, Optimism).
  • Note about archival RPC requirement for old blocks.
  • Explanation of slot numbering (decimal vs hex), and how value padding works.
  • Security / trust assumptions if used in production.

Benefits:

  • Lower friction for new users.
  • Clearer expectations (especially about limitations or edge cases).
  • Helps adoption and safer use.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions