Skip to content

Commit adb6614

Browse files
committed
chore: update version + installation instructions
1 parent 45b6ded commit adb6614

File tree

2 files changed

+27
-29
lines changed

2 files changed

+27
-29
lines changed

README.md

Lines changed: 26 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
![Next.js on Netlify Build Plugin](next-on-netlify.png)
22

3-
# Next.js Build Plugin
3+
# Essential Next.js Build Plugin
44

55
<p align="center">
66
<a aria-label="npm version" href="https://www.npmjs.com/package/@netlify/plugin-nextjs">
@@ -26,46 +26,44 @@ This build plugin is a utility for supporting Next.js on Netlify. To enable serv
2626

2727
## Installation and Configuration
2828

29-
There are two ways to install the plugin in your Next.js on Netlify site: with the Netlify UI or with file-based installation.
29+
As of v3.0.0, all new sites deployed to Netlify with Next.js will automatically build with this plugin for a seamless experience deploying Next.js on Netlify!
3030

31-
**UI-based Installation**
31+
This means that you don't have to do anything — just build and deploy your site to Netlify as usual and we'll handle the rest.
3232

33-
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.
33+
You're able to remove the plugin at any time by visiting the Plugins tab on your site.
3434

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

37-
**File-based Installation**
37+
1\. Create a `netlify.toml` in the root of your project. Your file should include the plugins section below:
3838

39-
1. Create a `netlify.toml` in the root of your project. Your file should include the plugins section below:
40-
41-
```toml
42-
[build]
43-
command = "npm run build"
44-
publish = "out"
39+
```toml
40+
[build]
41+
command = "npm run build"
42+
publish = "out"
4543

46-
[[plugins]]
47-
package = "@netlify/plugin-nextjs"
48-
```
44+
[[plugins]]
45+
package = "@netlify/plugin-nextjs"
46+
```
4947

5048
You can also add context-specific properties and environment variables to your `netlify.toml`. Read more about [deploy contexts](https://docs.netlify.com/configure-builds/file-based-configuration/#deploy-contexts) in our docs. For example:
5149

52-
```toml
53-
[context.production.environment]
54-
NEXT_SERVERLESS = "true"
55-
NODE_ENV = "production"
56-
```
50+
```toml
51+
[context.production.environment]
52+
NEXT_SERVERLESS = "true"
53+
NODE_ENV = "production"
54+
```
5755

58-
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`.
56+
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`.
5957

60-
```
61-
npm install -D @netlify/plugin-nextjs
62-
```
58+
```
59+
npm install -D @netlify/plugin-nextjs
60+
```
6361

64-
or
62+
or
6563

66-
```
67-
yarn add -D @netlify/plugin-nextjs
68-
```
64+
```
65+
yarn add -D @netlify/plugin-nextjs
66+
```
6967

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

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@netlify/plugin-nextjs",
3-
"version": "3.0.0-canary.1",
3+
"version": "3.0.0",
44
"description": "run Nextj.s seamlessly on netlify",
55
"main": "index.js",
66
"files": [

0 commit comments

Comments
 (0)