Skip to content
This repository was archived by the owner on May 10, 2021. It is now read-only.

Commit 18a7082

Browse files
update README to explain the future of next on netlify (#114)
* update README to explain the future of Next.js on Netlify * requested changes
1 parent f2e5d40 commit 18a7082

File tree

2 files changed

+25
-4
lines changed

2 files changed

+25
-4
lines changed

.prettierignore

+3
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,6 @@ jspm_packages
4343
# Optional REPL history
4444
.node_repl_history
4545
.next
46+
47+
# Github
48+
.github

README.md

+22-4
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,25 @@
1515
</a>
1616
</p>
1717

18-
1918
`next-on-netlify` is a utility for enabling server-side rendering in Next.js on Netlify. It wraps your application in a tiny compatibility layer, so that pages can use Netlify Functions to be server-side rendered.
2019

21-
**TL;DR: You can enable SSR in your Next.js applications with 3 simple steps, listed [here](#setup)!**
20+
- Build plugin [@netlify/plugin-nextjs](https://github.com/netlify/netlify-plugin-nextjs)
21+
- [Plugin npm package](https://www.npmjs.com/package/@netlify/plugin-nextjs)
22+
23+
## Next on Netlify Roadmap
24+
25+
The future of Next.js on Netlify is growing beyond `next-on-netlify`. The recommended path forward is to install [@netlify/plugin-nextjs](https://github.com/netlify/netlify-plugin-nextjs) - a build plugin released and supported by the team behind `next-on-netlify`.
26+
27+
The plugin relies on `next-on-netlify` but offers a smoother experience, including:
28+
29+
1. one-click, zero-config installation
30+
2. allowing custom functions and publish directories
2231

23-
- Demo: https://next-on.netlify.com/
24-
- Example repository: https://github.com/netlify-labs/next-on-netlify-demo
32+
See the [plugin's README](https://github.com/netlify/netlify-plugin-nextjs#readme) for more information. Our team's end goal is to make the Next.js on Netlify experience as seamless as possible.
33+
34+
Note: since `next-on-netlify` will remain the primary source of logic for Next.js on Netlify, the existing `next-on-netlify` setup will continue to work for users who prefer manual installation and configuration.
35+
36+
The plugin can be found on [npm here](https://www.npmjs.com/package/@netlify/plugin-nextjs).
2537

2638
## Table of Contents
2739

@@ -30,6 +42,7 @@
3042
- [1. Set Next.js target to serverless](#1-set-nextjs-target-to-serverless)
3143
- [2. Add postbuild hook](#2-add-postbuild-hook)
3244
- [3. Configure Netlify](#3-configure-netlify)
45+
- [Demo](#demo)
3346
- [Optional Extras](#optional-extras)
3447
- [Preview Locally](#preview-locally)
3548
- [Custom Netlify Redirects](#custom-netlify-redirects)
@@ -110,6 +123,11 @@ Note: `out_functions` and `out_publish` are hard-coded into next-on-netlify. The
110123

111124
We're done. Let's deploy 🚀🚀🚀
112125

126+
## Demo
127+
128+
- Site: https://next-on.netlify.com/
129+
- Code: https://github.com/netlify-labs/next-on-netlify-demo
130+
113131
## Optional Extras
114132

115133
#### Preview Locally

0 commit comments

Comments
 (0)