Skip to content

Polish the README header, features and table of contents - #3

Merged
devmaxxx merged 1 commit into
mainfrom
docs/readme-polish
Oct 16, 2026
Merged

devmaxxx merged 1 commit into
mainfrom
docs/readme-polish

Conversation

@devmaxxx

Copy link
Copy Markdown
Owner

Summary

  • Centered header with tagline, npm version, downloads, types, CI and license badges, and a quick-links line.
  • Features list rewritten with bold leads, including that parsing uses the browser's own HTML5 parser.
  • Table of contents, a note under Install that browser entries need a DOM (links the server-rendering recipe), changelog and releases links in Contributing, and the copyright holder under License.

Test plan

  • prettier --check README.md
  • Every badge URL returns 200
  • Rendered README on GitHub looks right

@devmaxxx
devmaxxx merged commit e2c9410 into main Oct 16, 2026
1 check passed
@devmaxxx
devmaxxx deleted the docs/readme-polish branch October 16, 2026 22:46
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