Skip to content

README incomplete and missing migration guidance for maintenance mode #2410

@arawrdn

Description

@arawrdn

The README has several issues that make it harder to use:

  1. Truncated content: The security note at the end cuts off mid-sentence ("Please understand the security implications of opening up an H").

  2. Unclear migration path: The maintenance mode warning points to op-geth but doesn't provide migration steps, timeline, or EOL date. Users need concrete guidance on when to migrate and how.

  3. Missing standard sections: No contributing guidelines or license information in the body (only in repo metadata).

  4. Potentially stale content: Testnet sections (Alfajores, Baklava) and Docker image links may be outdated given maintenance status.

Suggestions:

  • Complete the truncated security section
  • Add a migration guide section with op-geth quickstart
  • Clarify maintenance timeline and EOL date
  • Add license badge and contributing section or explicitly state contributions are not accepted
  • Update or remove testnet sections if they're no longer relevant

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions