Skip to content

Commit 0bf8a65

Browse files
authored
Add note for NextJS users (#241)
1 parent aca0725 commit 0bf8a65

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

README.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,21 @@
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 get started, you can run:
14+
15+
```shell
16+
[npm|yarn|pnpm] [install|add] @p5-wrapper/next react-p5-wrapper
17+
```
18+
19+
Please continue reading these docs and also look at
20+
[the NextJS dynamic implementation docs](https://github.com/P5-wrapper/next) for
21+
further supporting information.
22+
823
## Demo & Examples
924

1025
### Live demo
@@ -31,22 +46,11 @@ Then just open `http://localhost:3001` in a browser.
3146

3247
## Installation
3348

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

42-
```sh
43-
pnpm add react-p5-wrapper
44-
```
45-
46-
### Yarn
47-
48-
```sh
49-
yarn add react-p5-wrapper
52+
```shell
53+
[npm|yarn|pnpm] [install|add] react-p5-wrapper
5054
```
5155

5256
## Usage

0 commit comments

Comments
 (0)