chore: new README.md for 3.x.x release #206
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Create fresh README structure with modern layout - Feature demo page prominently in hero section - Maintain tagline: "Private, performant YouTube embeds for React. Under 5KB gzipped." - Reorganize content for better scannability and progressive disclosure - Add "Why This Component?" section with clear value proposition - Include real-world use cases and code examples - Improve API reference organization (by usage pattern) - Enhance Quick Start section for faster onboarding - Preserve all technical documentation and props - Better mobile/GitHub reading experience File saved as README.new.md for evaluation before replacing current README.
Contributor
size-limit report 📦
|
- Modern structure with demo-first approach - Tagline prominently featured: "Private, performant YouTube embeds for React. Under 5KB gzipped." - Clear value proposition in "Why This Component?" section - Progressive disclosure from Quick Start to advanced features - Real-world use cases with copy-paste examples - Better organized API reference by usage pattern - Improved scannability and mobile experience - Made with 🧩 in Brazil 🇧🇷
ibrahimcesar
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
File saved as README.new.md for evaluation before replacing current README.