Skip to content

Commit

Permalink
Update README.md (#341)
Browse files Browse the repository at this point in the history
  • Loading branch information
willeastcott authored Feb 4, 2024
1 parent 9fcfa44 commit a0d6952
Showing 1 changed file with 5 additions and 9 deletions.
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,9 @@ A full guide to using the PCUI library can be found [here](https://playcanvas.gi

To install the PCUI NPM module, run the following command:

```
npm install @playcanvas/pcui
```
npm install @playcanvas/pcui --save-dev

If you are using ESM, you can then import each individual element from PCUI. In the example below you can see how the PCUI `Label` component is imported from the PCUI library. The styles for PCUI are then imported into the example. Styles only need to be imported once per project.
You can then import each individual element from PCUI. In the example below, you can see how the PCUI `Label` component is imported from the PCUI library. The styles for PCUI are then imported into the example. Styles only need to be imported once per project.

```javascript
import { Label } from '@playcanvas/pcui';
Expand Down Expand Up @@ -46,7 +44,7 @@ ReactDOM.render(

## Building a UMD bundle

If you need a UMD version of the library so that you for example, it can used with a PlayCanvas Editor project, please refer to our [build guide](BUILDGUIDE.md).
If you need a UMD version of the PCUI library (say, to use it in a PlayCanvas Editor project), please refer to our [build guide](BUILDGUIDE.md).

## Including your own font

Expand Down Expand Up @@ -127,10 +125,8 @@ If you wish to view all components available to you in the library, you can run
Run Storybook as follows:
```
npm install
npm run storybook
```
npm install
npm run storybook
## Documentation
Expand Down

0 comments on commit a0d6952

Please sign in to comment.