Skip to content

Commit d420f70

Browse files
authored
README edits to installation process (#68)
* Edits to installation process * Edits to installation process * devDependencies is more specific
1 parent d0f2dbe commit d420f70

File tree

1 file changed

+23
-13
lines changed

1 file changed

+23
-13
lines changed

README.md

+23-13
Original file line numberDiff line numberDiff line change
@@ -25,27 +25,37 @@ This build plugin is a utility for supporting Next.js on Netlify. To enable serv
2525

2626
## Installation and Configuration
2727

28-
There are two ways to install the plugin in your Next.js on Netlify site.
28+
There are two ways to install the plugin in your Next.js on Netlify site: with the Netlify UI or with file-based installation.
2929

30-
**Option 1: UI-based Installation**
30+
**UI-based Installation**
3131

32-
This plugin can be installed and managed from your site's settings on Netlify.
33-
34-
[👉 Click to install this plugin 👈](http://app.netlify.com/plugins/@netlify/plugin-nextjs/install)
32+
You can install this plugin using this [direct in-app installation link](http://app.netlify.com/plugins/@netlify/plugin-nextjs/install) or from your team's [Plugins directory](https://app.netlify.com/plugins) in the Netlify UI.
3533

3634
Read more about [UI-based plugin installation](https://docs.netlify.com/configure-builds/build-plugins/#ui-installation) in our docs.
3735

38-
**Option 2: File-based Installation**
36+
**File-based Installation**
3937

40-
Create a `netlify.toml` in the root of your project. Your file should include the plugins section below:
38+
1. Create a `netlify.toml` in the root of your project. Your file should include the plugins section below:
4139

42-
```toml
43-
[build]
44-
command = "npm run build"
40+
```toml
41+
[build]
42+
command = "npm run build"
43+
44+
[[plugins]]
45+
package = "@netlify/plugin-nextjs"
46+
```
4547

46-
[[plugins]]
47-
package = "@netlify/plugin-nextjs"
48-
```
48+
2. From your project's base directory, use `npm`, `yarn`, or any other Node.js package manager to add this plugin to `devDependencies` in `package.json`.
49+
50+
```
51+
npm install -D @netlify/plugin-nextjs
52+
```
53+
54+
or
55+
56+
```
57+
yarn add -D @netlify/plugin-nextjs
58+
```
4959

5060
Read more about [file-based plugin installation](https://docs.netlify.com/configure-builds/build-plugins/#file-based-installation) in our docs.
5161

0 commit comments

Comments
 (0)