Skip to content

docs: enhance README with badges, features, and comparison table#29

Open
tedteddy wants to merge 1 commit intoomni-door:masterfrom
tedteddy:docs/enhance-readme
Open

docs: enhance README with badges, features, and comparison table#29
tedteddy wants to merge 1 commit intoomni-door:masterfrom
tedteddy:docs/enhance-readme

Conversation

@tedteddy
Copy link
Copy Markdown
Member

Summary

This PR enhances the README.md to improve project visibility and help users understand the value proposition.

Changes

  • Added more badges (GitHub stars, TypeScript, PRs Welcome)
  • Added "Why omni-door?" section explaining key benefits
  • Added Features table with icons
  • Added Comparison table with other popular tools (CRA, vue-cli, vite)
  • Added Supported Project Types table
  • Added Contributing section

Why

A comprehensive README helps:

  • Attract more users and contributors
  • Clearly communicate what the project does
  • Show how it compares to alternatives

Checklist

  • No code changes
  • Documentation only

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