docs: modernize README and improve npm discoverability#8591
Merged
willeastcott merged 9 commits intomainfrom Apr 13, 2026
Merged
docs: modernize README and improve npm discoverability#8591willeastcott merged 9 commits intomainfrom
willeastcott merged 9 commits intomainfrom
Conversation
Update package description, keywords, and all README translations to better reflect the engine's current capabilities and improve npm search ranking. Made-with: Cursor
Made-with: Cursor
Made-with: Cursor
Contributor
There was a problem hiding this comment.
Pull request overview
Modernizes the project READMEs and npm package metadata to better reflect current engine capabilities and improve npm discoverability.
Changes:
- Updated
package.jsondescription and expanded npm keywords for better search relevance. - Reworked README structure across languages (Install/Usage/Features/Ecosystem ordering) and refreshed the usage snippet (named imports +
rendercomponent). - Added Gaussian Splatting to Features and introduced an Ecosystem section linking related packages.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds Install + Ecosystem sections, updates usage example to named imports and render component, refreshes features list. |
| README-zh.md | Aligns structure/content with English README; adds Install/Features/Ecosystem sections and updates usage example. |
| README-kr.md | Aligns structure/content with English README; updates language links to dev, adds Install/Features/Ecosystem, updates usage example. |
| README-ja.md | Aligns structure/content with English README; adds Install/Features/Ecosystem sections and updates usage example. |
| package.json | Updates package description and keywords to improve npm discoverability. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Made-with: Cursor
Made-with: Cursor
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Made-with: Cursor
Made-with: Cursor
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.
Summary
Modernize the README and package metadata to improve npm discoverability and better reflect the engine's current capabilities.
package.json
3d-engine,game-engine,gaussian-splatting,physics,renderer,scene-graph,ecsREADME.md (all languages)
npm install playcanvasandnpm create playcanvas@latestmodelcomponent withrenderin the usage exampleimport * as pc) to named imports for tree-shaking@playcanvas/react,@playcanvas/web-components,create-playcanvasmastertodevbranch