Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README files to show ESM usage #6112

Merged
merged 3 commits into from
Mar 6, 2024
Merged

Update README files to show ESM usage #6112

merged 3 commits into from
Mar 6, 2024

Conversation

willeastcott
Copy link
Contributor

@willeastcott willeastcott commented Mar 6, 2024

Tweak the repo README:

  • Switch from UMD example usage to ESM.
  • Link to the full engine 'getting started' guide on the Developer Site.
  • Remove reference to code.playcanvas.com (we don't want to encourage devs to use this)
  • Simplify the build commands table.
  • Translate to kr, zh and ja.

I confirm I have read the contributing guidelines and signed the Contributor License Agreement.

@willeastcott willeastcott added docs Documentation related enhancement labels Mar 6, 2024
@willeastcott willeastcott requested a review from mvaligursky March 6, 2024 13:48
@willeastcott willeastcott self-assigned this Mar 6, 2024
@Maksims
Copy link
Collaborator

Maksims commented Mar 6, 2024

The beauty of the current code is that you can just copy it into clean html, and launch it.

@willeastcott
Copy link
Contributor Author

willeastcott commented Mar 6, 2024

@Maksims Yeah, I totally agree with you. But we are deprecating both the UMD builds and code.playcanvas.com sometime in the not too distant future. We need new devs to dive right in with ESM (and NPM)....even if the results aren't quite so immediate.

What I'm also trying to do here is streamline the README. It's too verbose IMHO.

@willeastcott willeastcott requested a review from slimbuck March 6, 2024 14:14
@willeastcott willeastcott merged commit 40e119c into main Mar 6, 2024
7 checks passed
@willeastcott willeastcott deleted the readme-esm branch March 6, 2024 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants