Skip to content

Commit e3827c5

Browse files
committed
chore: update readme for GA
1 parent a5e09ab commit e3827c5

File tree

1 file changed

+29
-14
lines changed

1 file changed

+29
-14
lines changed

README.md

+29-14
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
1-
![Next.js on Netlify Build Plugin](next-on-netlify.png)
1+
![Essential Next.js Build Plugin](next-on-netlify.png)
22

3-
# Essential Next.js Build Plugin (beta)
4-
5-
:warning: This is the beta version of the Essential Next.js plugin. For the stable version, refer to
6-
[Essential Next.js plugin v3](https://github.com/netlify/netlify-plugin-nextjs/tree/v3#readme) :warning:
3+
# Essential Next.js Build Plugin
74

85
<p align="center">
96
<a aria-label="npm version" href="https://www.npmjs.com/package/@netlify/plugin-nextjs">
@@ -19,31 +16,48 @@
1916
Version 4 is a complete rewrite of the Essential Next.js plugin. For full details of everything that's new, check out
2017
[the v4 release notes](https://github.com/netlify/netlify-plugin-nextjs/blob/main/docs/release-notes/v4.md)
2118

22-
## Installing the beta
19+
## Installing the plugin
20+
21+
The plugin should be installed automatically for new Next.js sites on Netlify. You can also install it manually like
22+
this:
2323

2424
- Install the module:
2525

2626
```shell
27-
npm install -D @netlify/plugin-nextjs@beta
27+
npm install -D @netlify/plugin-nextjs
2828
```
2929

30-
- Change the `publish` directory to `.next` and add the plugin to `netlify.toml` if not already installed:
30+
...then add it to your `netlify.toml` file:
3131

3232
```toml
33-
[build]
34-
publish = ".next"
35-
3633
[[plugins]]
3734
package = "@netlify/plugin-nextjs"
3835
```
3936

37+
## Migrating from an older version of the plugin
38+
39+
You can manually upgrade from the previous version of the plugin by running the following command:
40+
41+
```shell
42+
npm install -D @netlify/plugin-nextjs@latest
43+
```
44+
45+
Change the `publish` directory to `.next`:
46+
47+
```toml
48+
[build]
49+
publish = ".next"
50+
```
51+
4052
If you previously set a custom `distDir` in your `next.config.js`, or set `node_bundler` or `external_node_modules` in
4153
your `netlify.toml` these are no longer needed and can be removed.
4254

4355
The `serverless` and `experimental-serverless-trace` targets are deprecated in Next 12, and all builds with this plugin
4456
will now use the default `server` target. If you previously set the target in your `next.config.js`, you should remove
4557
it.
4658

59+
## Monorepos
60+
4761
If you are using a monorepo you will need to change `publish` to point to the full path to the built `.next` directory,
4862
which may be in a subdirectory. If you have changed your `distDir` then it will need to match that.
4963

@@ -57,7 +71,8 @@ If you want to use Next 12's beta Middleware feature, this will mostly work as e
5771
[read the docs on some caveats and workarounds](https://github.com/netlify/netlify-plugin-nextjs/blob/main/docs/middleware.md)
5872
that are currently needed.
5973

60-
## Beta feedback
74+
## Feedback
6175

62-
Please share any thoughts, feedback or questions about the beta
63-
[in our discussion](https://github.com/netlify/netlify-plugin-nextjs/discussions/706).
76+
If you think you have found a bug in the plugin,
77+
[please open an issue](https://github.com/netlify/netlify-plugin-nextjs/issues). If you have comments or feature
78+
requests, [see the dicussion board](https://github.com/netlify/netlify-plugin-nextjs/discussions)

0 commit comments

Comments
 (0)