Skip to content

Commit c612ce2

Browse files
iKristyascorbic
authored andcommitted
chore: update readme
1 parent 264b9f0 commit c612ce2

File tree

2 files changed

+21
-8
lines changed

2 files changed

+21
-8
lines changed

README.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,34 @@
1-
# Essential Next.js (Experimental)
1+
![Next.js on Netlify Build Plugin](next-on-netlify.png)
22

3-
_Experimental plugin for Next.js applications on Netlify_
3+
# Essential Next.js Build Plugin (beta)
44

5-
:warning: This plugin is an alpha for testing purposes only. It is not yet stable and should not be used for production sites.
65

7-
## Installing the alpha
6+
:warning: This is the beta version of the Essential Next.js plugin. For the stable version, see [Essential Next.js plugin v3](https://github.com/netlify/netlify-plugin-nextjs/tree/v3#readme) :warning:
7+
8+
<p align="center">
9+
<a aria-label="npm version" href="https://www.npmjs.com/package/@netlify/plugin-nextjs">
10+
<img alt="" src="https://img.shields.io/npm/v/@netlify/plugin-nextjs">
11+
</a>
12+
<a aria-label="MIT License" href="https://img.shields.io/npm/l/@netlify/plugin-nextjs">
13+
<img alt="" src="https://img.shields.io/npm/l/@netlify/plugin-nextjs">
14+
</a>
15+
</p>
16+
17+
18+
## Installing the beta
19+
820

9-
- Remove the existing Essential Next.js plugin (`@netlify/plugin-nextjs`). See the instructions to [uninstall the plugin](https://ntl.fyi/remove-plugin)
1021
- Install the module:
1122
```shell
12-
npm install -D @netlify/plugin-nextjs-experimental
23+
npm install -D @netlify/plugin-nextjs@beta
1324
```
14-
- Change the `publish` directory to `.next` and add the plugin to `netlify.toml`:
25+
- Change the `publish` directory to `.next` and add the plugin to `netlify.toml` if not already installed:
1526
```toml
1627
[build]
1728
publish = ".next"
1829

1930
[[plugins]]
20-
package = "@netlify/plugin-nextjs-experimental"
31+
package = "@netlify/plugin-nextjs"
2132
```
33+
34+
If you previously set `target: "serverless"` in your `next.config.js` this is no longer needed and can be removed.

next-on-netlify.png

37.3 KB
Loading

0 commit comments

Comments
 (0)