Skip to content

docs: Actualize README for v5#556

Merged
jamesrweb merged 8 commits intomasterfrom
chore/update-readme
Mar 19, 2026
Merged

docs: Actualize README for v5#556
jamesrweb merged 8 commits intomasterfrom
chore/update-readme

Conversation

@yevdyko
Copy link
Contributor

@yevdyko yevdyko commented Mar 18, 2026

Related Issue

N/A

PR Type

  • 🐛 Bug Fix
  • ✨ New Feature
  • 🔨 Code Refactor
  • 📝 Documentation Update
  • 🧪 Test Update
  • 🔧 Build/CI Update
  • 🧹 Chore
  • ⏪ Revert

Description

The README still referenced v5 as in development and showed ReactP5Wrapper (v4) as the primary component in all examples. Since v5 is now released (5.0.2), the documentation needed to be brought up to date.

Proposed Changes

  • Remove the outdated "v5 is still in development" warning
  • Convert migration notes into a collapsible section with a link to the v4.4.1 documentation
  • Update React website link from reactjs.org to react.dev
  • Update peer dependencies section to show only v5 requirements
  • Replace all ReactP5Wrapper references with P5Canvas in code examples
  • Remove all duplicate "Version 5" collapsible detail sections
  • Clean up Error and Loading UIs section language

How Has This Been Tested?

  • Unit Tests
  • Integration Tests
  • Manual Testing (please describe)

Reviewed the rendered README to ensure all examples use P5Canvas, no stale ReactP5Wrapper references remain (except in the migration guide), and all links are correct.

Screenshots/Recordings

N/A

Breaking Changes

  • Yes (please describe)
  • No

Checklist

  • My code follows the code style of this project
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed
  • My changes generate no new warnings

Additional Notes

N/A

@yevdyko yevdyko requested a review from jamesrweb as a code owner March 18, 2026 12:51
@yevdyko yevdyko self-assigned this Mar 18, 2026
@yevdyko yevdyko added the documentation Pull requests that update project documentation label Mar 18, 2026
@yevdyko yevdyko force-pushed the chore/update-readme branch from d89863c to 6f6e42b Compare March 18, 2026 12:59
@yevdyko
Copy link
Contributor Author

yevdyko commented Mar 18, 2026

@jamesrweb The issue with the linter has been resolved in #554 and will be gone after its merge

@jamesrweb
Copy link
Member

@jamesrweb The issue with the linter has been resolved in #554 and will be gone after its merge

Merged it now, try rerunning the linter job 👌🏻

@github-actions
Copy link

github-actions bot commented Mar 18, 2026

Coverage report for commit: b8e7a64
File: ./coverage/clover.xml

Cover ┌─────────────────────────┐ Freq.
   0% │ ░░░░░░░░░░░░░░░░░░░░░░░ │  0.0%
  10% │ ░░░░░░░░░░░░░░░░░░░░░░░ │  0.0%
  20% │ ░░░░░░░░░░░░░░░░░░░░░░░ │  0.0%
  30% │ ░░░░░░░░░░░░░░░░░░░░░░░ │  0.0%
  40% │ ░░░░░░░░░░░░░░░░░░░░░░░ │  0.0%
  50% │ ░░░░░░░░░░░░░░░░░░░░░░░ │  0.0%
  60% │ ░░░░░░░░░░░░░░░░░░░░░░░ │  0.0%
  70% │ ░░░░░░░░░░░░░░░░░░░░░░░ │  0.0%
  80% │ ░░░░░░░░░░░░░░░░░░░░░░░ │  0.0%
  90% │ ░░░░░░░░░░░░░░░░░░░░░░░ │  0.0%
 100% │ ███████████████████████ │ 100.0%
      └─────────────────────────┘
 *Legend:* █ = Current Distribution 
Summary - Lines: 100.00% | Methods: 100.00% | Branches: 100.00%
FilesLinesMethodsBranches
src/components
   P5Canvas.tsx100.00%100.00%100.00%
   P5CanvasGuard.tsx100.00%100.00%100.00%
   P5CanvasWithSketch.tsx100.00%100.00%100.00%
src/constants
   CanvasContainerClassName.ts100.00%100.00%100.00%
src/contracts
   CanvasContainer.ts100.00%100.00%100.00%
   CanvasContainerRef.ts100.00%100.00%100.00%
   InputProps.ts100.00%100.00%100.00%
   P5CanvasInstance.ts100.00%100.00%100.00%
   P5CanvasInstanceRef.ts100.00%100.00%100.00%
   P5CanvasProps.ts100.00%100.00%100.00%
   P5CanvasPropsWithSketch.ts100.00%100.00%100.00%
   Sketch.ts100.00%100.00%100.00%
   SketchProps.ts100.00%100.00%100.00%
   WithChildren.ts100.00%100.00%100.00%
   p5.ts100.00%100.00%100.00%
src
   main.tsx100.00%100.00%100.00%
src/utils
   createP5CanvasInstance.ts100.00%100.00%100.00%
   logErrorBoundaryError.ts100.00%100.00%100.00%
   propsAreEqual.ts100.00%100.00%100.00%
   removeP5CanvasInstance.ts100.00%100.00%100.00%
   updateP5CanvasInstance.ts100.00%100.00%100.00%
   withoutKeys.ts100.00%100.00%100.00%

🤖 comment via lucassabreu/comment-coverage-clover

jamesrweb
jamesrweb previously approved these changes Mar 18, 2026
@jamesrweb jamesrweb enabled auto-merge March 18, 2026 16:42
@jamesrweb jamesrweb added this pull request to the merge queue Mar 18, 2026
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Mar 18, 2026
@yevdyko yevdyko added this pull request to the merge queue Mar 18, 2026
@yevdyko yevdyko removed this pull request from the merge queue due to a manual request Mar 18, 2026
@yevdyko yevdyko added this pull request to the merge queue Mar 18, 2026
@yevdyko yevdyko removed this pull request from the merge queue due to a manual request Mar 18, 2026
@yevdyko yevdyko enabled auto-merge March 18, 2026 18:33
@yevdyko yevdyko requested a review from jamesrweb March 18, 2026 18:33
@jamesrweb jamesrweb disabled auto-merge March 19, 2026 02:33
@jamesrweb jamesrweb merged commit 3a0b025 into master Mar 19, 2026
10 checks passed
@jamesrweb jamesrweb deleted the chore/update-readme branch March 19, 2026 02:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Pull requests that update project documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants