Skip to content

URLBuilder missing readme() method #5

@oritwoen

Description

@oritwoen

URLBuilder has methods for package, versions, and documentation URLs, but nothing for README content.

Each registry has a different way to access READMEs:

  • npm: jsdelivr CDN (/npm/{name}@{version}/README.md)
  • crates.io: API endpoint (/api/v1/crates/{name}/{version}/readme)
  • PyPI: project page (description is the readme)
  • RubyGems/Packagist: registry web page

Without readme() on URLBuilder, consumers have to hardcode these per-ecosystem URLs themselves. Should be part of the standard URL surface alongside documentation().

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions