Skip to content

Commit e650266

Browse files
committed
chore: update readme
1 parent e906742 commit e650266

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,20 @@
22

33
_Experimental plugin for Next.js applications on Netlify_
44

5-
:warning: This plugin is an early alpha, for testing purposes only. It is not feature-complete and should not be used for production sites.
5+
:warning: This plugin is an alpha for testing purposes only. It is not yet stable and should not be used for production sites.
66

7-
It does not support: i18n, basePath or preview mode, and monorepo support is limited. Do not report issues for sites that use these features.
8-
9-
## Installation
7+
## Installing the alpha
108

119
- Remove the existing Essential Next.js plugin (`@netlify/plugin-nextjs`). See the instructions to [uninstall the plugin](https://ntl.fyi/remove-plugin)
1210
- Install the module:
1311
```shell
1412
npm install -D @netlify/plugin-nextjs-experimental
1513
```
16-
- Add to `netlify.toml`:
14+
- Change the `publish` directory to `.next` and add the plugin to `netlify.toml`:
1715
```toml
16+
[build]
17+
publish = ".next"
18+
1819
[[plugins]]
1920
package = "@netlify/plugin-nextjs-experimental"
2021
```
21-
22-
Unlike the existing plugin, this does not require `target` to be set to `serverless`, so you may remove that. It also does not currently support ESBuild, so if you had manually enabled it in your `netlify.toml`, you will need to remove that.
23-
24-
## Differences from the existing plugin
25-
The main difference from the existing plugin is that it no longer generates a function for each route. Instead it generates one builder function for pages with `fallback="blocking"` or `fallback="true"`, and another function for all other routes. It then uses Next.js's own routing system rather than Netlify's. This means that it support's Next.js rewrites and redirects, and no longer needs to generate a `_redirects` file. You can add your own Netlify redirects to `netlify.toml` if needed, and these will be applied before any Next.js routing.

0 commit comments

Comments
 (0)