Skip to content

docs(readme): modernize README for v4 alpha - #1999

Merged
hshoff merged 1 commit into
masterfrom
hshoff/readme-updates
Apr 14, 2026
Merged

docs(readme): modernize README for v4 alpha#1999
hshoff merged 1 commit into
masterfrom
hshoff/readme-updates

Conversation

@hshoff

@hshoff hshoff commented Apr 14, 2026

Copy link
Copy Markdown
Member

📝 Documentation

  • Add v4 alpha / React 19 admonition with @next install instructions
  • Modernize bar chart example: replace compose pattern with named accessors, key on data value instead of index
  • Update componentDidMount() → useEffect() reference
  • Fix preact-compat → preact/compat
  • Remove outdated lerna badge, old Medium blog links, and duplicate "Getting started" link
  • Remove stale "In the wild" section and old animation library examples from FAQ

@hshoff hshoff added this to the 4.0.0 milestone Apr 14, 2026
@hshoff
hshoff requested a review from Copilot April 14, 2026 15:17

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the repository README to reflect the v4 alpha release status (React 19 support) and modernizes/cleans up documentation content for current guidance.

Changes:

  • Adds a v4 alpha “IMPORTANT” note with @next installation instructions and links to migration/changelog.
  • Modernizes the README bar chart example (named accessors; stable keys).
  • Removes outdated links/sections and updates references (e.g., componentDidMount()useEffect(), preact-compatpreact/compat).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md
Update bar chart example to use named accessors instead of compose
pattern, add v4 alpha / React 19 admonition, remove outdated lerna
badge, old blog links, "In the wild" section, and stale FAQ examples.
Fix preact-compat → preact/compat and componentDidMount → useEffect.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@hshoff
hshoff force-pushed the hshoff/readme-updates branch from ea14ccb to 7ed458b Compare April 14, 2026 15:34
@hshoff
hshoff merged commit 26697c8 into master Apr 14, 2026
1 check passed
@tgfree45

Copy link
Copy Markdown

Very good thank you

@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version v4.0.0 of the packages modified 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants