Skip to content

docs: modernize README and improve npm discoverability#8591

Merged
willeastcott merged 9 commits intomainfrom
docs/modernize-readme
Apr 13, 2026
Merged

docs: modernize README and improve npm discoverability#8591
willeastcott merged 9 commits intomainfrom
docs/modernize-readme

Conversation

@willeastcott
Copy link
Copy Markdown
Contributor

Summary

Modernize the README and package metadata to improve npm discoverability and better reflect the engine's current capabilities.

package.json

  • Update description from "PlayCanvas WebGL game engine" to "Open-source WebGL/WebGPU 3D engine for the web"
  • Add high-value npm search keywords: 3d-engine, game-engine, gaussian-splatting, physics, renderer, scene-graph, ecs

README.md (all languages)

  • Add Install section with npm install playcanvas and npm create playcanvas@latest
  • Replace deprecated model component with render in the usage example
  • Switch from namespace import (import * as pc) to named imports for tree-shaking
  • Add Gaussian Splatting to the Features list
  • Update Graphics feature to reference WebGL2 & WebGPU (was WebGL 1.0 & 2.0 in JA/KR)
  • Add Ecosystem section linking to @playcanvas/react, @playcanvas/web-components, create-playcanvas
  • Reorder sections: Install, Usage, Features, Ecosystem, Showcase, Users, Build, Editor
  • Fix Korean README language links from master to dev branch

Update package description, keywords, and all README translations to better reflect the engine's current capabilities and improve npm search ranking.

Made-with: Cursor
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Modernizes the project READMEs and npm package metadata to better reflect current engine capabilities and improve npm discoverability.

Changes:

  • Updated package.json description 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 + render component).
  • 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.

Comment thread README-zh.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@willeastcott willeastcott merged commit fa2e1db into main Apr 13, 2026
8 checks passed
@willeastcott willeastcott deleted the docs/modernize-readme branch April 13, 2026 12:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement Request for a new feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants