Skip to content

Add note for NextJS users #241

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Apr 19, 2023
Merged

Add note for NextJS users #241

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 19 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,21 @@
A component to integrate [P5.js](https://p5js.org/) sketches into
[React](https://reactjs.org/) apps.

## NextJS

If you plan to use this component within a NextJS application, you should
instead use
[our NextJS dynamic implementation](https://github.com/P5-wrapper/next) instead.
To do get started, you can run:

```shell
[npm|yarn|pnpm] [install|add] @p5-wrapper/next react-p5-wrapper
```

Please continue reading these docs and also look at
[the NextJS dynamic implementation docs](https://github.com/P5-wrapper/next) for
further supporting information.

## Demo & Examples

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

## Installation

### NPM

```sh
npm install react-p5-wrapper
```

### PNPM
To install, use the following command in the format appropriate to your chosen
package manager:

```sh
pnpm add react-p5-wrapper
```

### Yarn

```sh
yarn add react-p5-wrapper
```shell
[npm|yarn|pnpm] [install|add] react-p5-wrapper
```

## Usage
Expand Down