Skip to content

docs: framework-free quick start in README#95

Merged
ohxyz merged 1 commit into
mainfrom
docs/readme-quickstart
Jun 24, 2026
Merged

docs: framework-free quick start in README#95
ohxyz merged 1 commit into
mainfrom
docs/readme-quickstart

Conversation

@ohxyz

@ohxyz ohxyz commented Jun 24, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Lead the README with a self-contained, no-build-step Quick start using a CDN + import map
  • Note the npm + bundler path for app development
  • Add "Works with any framework or none" to the intro
  • Move Development and Environment setup out of the README into a new CONTRIBUTING.md

Why

For an open-source project the README should get a user to a working window fast, not document contributor setup. Dev/env details now live in CONTRIBUTING.md.

@ohxyz ohxyz requested a review from bhjsdev as a code owner June 24, 2026 03:39
@ohxyz ohxyz merged commit 83f4c07 into main Jun 24, 2026
@ohxyz ohxyz deleted the docs/readme-quickstart branch June 24, 2026 03:40
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