Skip to content

docs(uri): add Compared to alternatives section#13

Merged
ob-aion merged 2 commits into
mainfrom
docs/compared-to-alternatives
May 21, 2026
Merged

docs(uri): add Compared to alternatives section#13
ob-aion merged 2 commits into
mainfrom
docs/compared-to-alternatives

Conversation

@ob-aion
Copy link
Copy Markdown
Collaborator

@ob-aion ob-aion commented May 21, 2026

Summary

  • Adds a ## Compared to alternatives section to the README, mirroring the pattern in @coroboros/clone.
  • Compares @coroboros/uri against Node's native URL (WHATWG), uri-js, whatwg-url, and url-parse.
  • Table rows are feature-presence only (RFC-3986 parse, §5.2 resolve, recompose, Punycode, RFC 6874 zone IDs, IP/domain validators, Sitemap validation, coded errors, deps) — no performance numbers, since the alternatives split between WHATWG and RFC-3986 models.
  • Positioning paragraph names the gap (validation + Sitemap on top of RFC-3986 strict semantics) and the closest peer (uri-js).
  • TOC entry added between Limitations and Contributing.

Test plan

  • Render the README on github.com — anchor #compared-to-alternatives resolves from the TOC.
  • Table renders with right-aligned status columns in GitHub-flavored markdown.
  • No regressions in existing sections (Compliance, API, Errors, Limitations).

ob-aion added 2 commits May 21, 2026 16:09
Mirrors the pattern from @coroboros/clone: feature-presence table
plus a positioning paragraph. Compares against native `URL` (WHATWG),
`uri-js`, `whatwg-url`, and `url-parse`. TOC updated; section sits
between Limitations and Contributing.
'Differentiator' read as product-strategy register. 'Gap' is more
neutral and aligns with the existing sparkline opener.
@ob-aion ob-aion merged commit 988e226 into main May 21, 2026
5 checks passed
@ob-aion ob-aion deleted the docs/compared-to-alternatives branch May 21, 2026 09:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant