Skip to content

Commit 9444d9a

Browse files
committed
Add note for NextJS users
1 parent aca0725 commit 9444d9a

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,19 @@
55
A component to integrate [P5.js](https://p5js.org/) sketches into
66
[React](https://reactjs.org/) apps.
77

8+
## NextJS
9+
10+
If you plan to use this component within a NextJS application, you should
11+
instead use
12+
[our NextJS dynamic implementation](https://github.com/P5-wrapper/next) instead.
13+
To do so, you can run:
14+
15+
```shell
16+
[npm|yarn|pnpm] [install|add] @p5-wrapper/next react-p5-wrapper
17+
```
18+
19+
Please look at [the NextJS dynamic implementation docs](https://github.com/P5-wrapper/next) for more information.
20+
821
## Demo & Examples
922

1023
### Live demo
@@ -31,22 +44,11 @@ Then just open `http://localhost:3001` in a browser.
3144

3245
## Installation
3346

34-
### NPM
35-
36-
```sh
37-
npm install react-p5-wrapper
38-
```
39-
40-
### PNPM
47+
To install, use the following command in the format appropriate to your chosen
48+
package manager:
4149

42-
```sh
43-
pnpm add react-p5-wrapper
44-
```
45-
46-
### Yarn
47-
48-
```sh
49-
yarn add react-p5-wrapper
50+
```shell
51+
[npm|yarn|pnpm] [install|add] react-p5-wrapper
5052
```
5153

5254
## Usage

0 commit comments

Comments
 (0)