Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
willeastcott authored Dec 12, 2024
1 parent 220616b commit 2336336
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,21 +32,24 @@ See PlayCanvas Web Components in action here: https://playcanvas.github.io/web-c

## Usage 🚧

If you are using a bundler (e.g. Rollup), you can install PlayCanvas Web Components and the PlayCanvas Engine using NPM:
### NPM

PlayCanvas Web Components is available as a package on [NPM](https://www.npmjs.com/package/@playcanvas/web-components).
If you are using a bundler (e.g. Rollup), you can install it (and the PlayCanvas Engine):

```bash
npm install playcanvas @playcanvas/web-components --save-dev
```

Or you can include it directly in your HTML file from a CDN.

ES Modules:
### ES Modules:

```html
<script type="module" src="https://cdn.jsdelivr.net/npm/@playcanvas/[email protected]/dist/pwc.mjs"></script>
```

UMD:
### UMD:

```html
<script src="https://cdn.jsdelivr.net/npm/@playcanvas/[email protected]"></script>
Expand Down

0 comments on commit 2336336

Please sign in to comment.