docs: restructure README toward GTM draft#19
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR restructures the root README to align with a new GTM-oriented narrative: a “write once in React” tagline, clearer positioning around multi-output rendering (Email/Web/Document), and expanded marketing-focused sections.
Changes:
- Updates the intro to emphasize a single component tree rendering to email, web, and document/PDF outputs, and adds a demo GIF.
- Adds a “Why Elements?” comparison table and Unlayer social-proof positioning.
- Replaces the prior feature bullet list with expanded feature subsections plus “Real-World Use Cases”.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
f96c550 to
337875e
Compare
- Add "Write once in React" tagline and an open-source intro with Email/Web/Document output bullets and a short "built by Unlayer" note - Add demo GIF (assets/elements-demo.gif) and a "Why Elements?" comparison table - Expand Features into sections (One Component Tree, React Developer Workflow, Production Output, Visual Builder Compatible, TypeScript First, Clean HTML, Lightweight & Tree-Shakeable) - Add "Real-World Use Cases" (transactional, PDF, CMS-driven, email+web parity) Kept from the existing README: npm/CI/license/downloads badges, architecture image, Components table, docs link, Packages table, and Development commands. Bundle size stated as ~12KB gzipped (under 60KB ESM) to match the CI gate (built bundle is 50,699 bytes). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
337875e to
4cf8457
Compare
ktwundering
approved these changes
Jun 17, 2026
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
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.
Kept from the existing README: npm/CI/license/downloads badges, architecture image, accurate Components table, working docs link, real Packages table, and Development commands.
Summary
What does this PR do? Keep it brief.
Changes
Test Plan
pnpm buildpassespnpm testpassesNotes
Any additional context for reviewers.
📖 Storybook Preview: https://unlayer.github.io/elements/pr/19/