Simplify create-next-app README #10545

chibicode · 2020-02-16T00:56:35Z

This PR updates the README file that gets copied when the user runs create-next-app.

First, this fixes a bug where README.md file actually was not correctly copied when the user runs create-next-app. This was happening because create-next-app gets built using ncc which in turn uses webpack-asset-relocator-loader, which ignores README.md. I renamed the file as README-template.md as a workaround.

I’ve removed the following sections because they're mostly covered by Learn and Docs. I think we should keep the README as simple as possible and just point them to docs/learn, instead of adding what's on docs/learn.

Available commands: The only relevant command to get started is dev, so I focused on that instead of talking about build or start.
Folder Structure: Covered in Learn and getting started docs, no need to add it here
Using CSS: Covered in Learn and docs , no need to add it here
Adding Components: Covered in Learn, no need to add it here
Fetching data: Covered in Learn and docs, no need to add it here
Syntax highlighting: This is not specific to Next.js - seems like it was copied from create-react-app docs
Table of Contents: Because I'm removing most contents from README, it's much shorter now and therefore Table of Contents is unnecessary

Instead, I focused on the three most important things for this README:

Showing where to start
Showing how to learn more about Next.js
Showing how to deploy on ZEIT

ijjk · 2020-02-16T01:02:25Z

Stats from current PR

Default Server Mode

General

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
buildDuration	12.1s	11.8s	-240ms
nodeModulesSize	52.7 MB	52.7 MB	✓

Client Bundles (main, webpack, commons)

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
main-HASH.js gzip	5.14 kB	5.14 kB	✓
webpack-HASH.js gzip	746 B	746 B	✓
4952ddcd88e7..54d3.js gzip	4.68 kB	4.68 kB	✓
commons.HASH.js gzip	4.06 kB	4.06 kB	✓
de003c3a9d30..4e43.js gzip	16.2 kB	16.2 kB	✓
framework.HASH.js gzip	39.1 kB	39.1 kB	✓
Overall change	70 kB	70 kB	✓

Client Bundles (main, webpack, commons) Modern

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
main-HASH.module.js gzip	4.14 kB	4.14 kB	✓
webpack-HASH..dule.js gzip	746 B	746 B	✓
4952ddcd88e7..dule.js gzip	5.56 kB	5.56 kB	✓
de003c3a9d30..dule.js gzip	15.1 kB	15.1 kB	✓
framework.HA..dule.js gzip	39.1 kB	39.1 kB	✓
Overall change	64.7 kB	64.7 kB	✓

Legacy Client Bundles (polyfills)

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
polyfills-HASH.js gzip	4.76 kB	4.76 kB	✓
Overall change	4.76 kB	4.76 kB	✓

Client Pages

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_app.js gzip	1.15 kB	1.15 kB	✓
_error.js gzip	4.07 kB	4.07 kB	✓
hooks.js gzip	779 B	779 B	✓
index.js gzip	222 B	222 B	✓
link.js gzip	2.89 kB	2.89 kB	✓
routerDirect.js gzip	283 B	283 B	✓
withRouter.js gzip	282 B	282 B	✓
Overall change	9.68 kB	9.68 kB	✓

Client Pages Modern

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_app.module.js gzip	576 B	576 B	✓
_error.module.js gzip	3.06 kB	3.06 kB	✓
hooks.module.js gzip	371 B	371 B	✓
index.module.js gzip	212 B	212 B	✓
link.module.js gzip	2.46 kB	2.46 kB	✓
routerDirect..dule.js gzip	273 B	273 B	✓
withRouter.m..dule.js gzip	272 B	272 B	✓
Overall change	7.22 kB	7.22 kB	✓

Client Build Manifests

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_buildManifest.js gzip	61 B	61 B	✓
_buildManife..dule.js gzip	61 B	61 B	✓
Overall change	122 B	122 B	✓

Rendered Page Sizes

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
index.html gzip	1.03 kB	1.03 kB	✓
link.html gzip	1.04 kB	1.04 kB	✓
withRouter.html gzip	1.03 kB	1.03 kB	✓
Overall change	3.11 kB	3.11 kB	✓

Serverless Mode (Decrease detected ✓)

General

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
buildDuration	12.5s	12.4s	-102ms
nodeModulesSize	52.7 MB	52.7 MB	✓

Client Bundles (main, webpack, commons)

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
main-HASH.js gzip	5.14 kB	5.14 kB	✓
webpack-HASH.js gzip	746 B	746 B	✓
4952ddcd88e7..54d3.js gzip	4.68 kB	4.68 kB	✓
commons.HASH.js gzip	4.06 kB	4.06 kB	✓
de003c3a9d30..4e43.js gzip	16.2 kB	16.2 kB	✓
framework.HASH.js gzip	39.1 kB	39.1 kB	✓
Overall change	70 kB	70 kB	✓

Client Bundles (main, webpack, commons) Modern

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
main-HASH.module.js gzip	4.14 kB	4.14 kB	✓
webpack-HASH..dule.js gzip	746 B	746 B	✓
4952ddcd88e7..dule.js gzip	5.56 kB	5.56 kB	✓
de003c3a9d30..dule.js gzip	15.1 kB	15.1 kB	✓
framework.HA..dule.js gzip	39.1 kB	39.1 kB	✓
Overall change	64.7 kB	64.7 kB	✓

Legacy Client Bundles (polyfills)

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
polyfills-HASH.js gzip	4.76 kB	4.76 kB	✓
Overall change	4.76 kB	4.76 kB	✓

Client Pages

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_app.js gzip	1.15 kB	1.15 kB	✓
_error.js gzip	4.07 kB	4.07 kB	✓
hooks.js gzip	779 B	779 B	✓
index.js gzip	222 B	222 B	✓
link.js gzip	2.89 kB	2.89 kB	✓
routerDirect.js gzip	283 B	283 B	✓
withRouter.js gzip	282 B	282 B	✓
Overall change	9.68 kB	9.68 kB	✓

Client Pages Modern

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_app.module.js gzip	576 B	576 B	✓
_error.module.js gzip	3.06 kB	3.06 kB	✓
hooks.module.js gzip	371 B	371 B	✓
index.module.js gzip	212 B	212 B	✓
link.module.js gzip	2.46 kB	2.46 kB	✓
routerDirect..dule.js gzip	273 B	273 B	✓
withRouter.m..dule.js gzip	272 B	272 B	✓
Overall change	7.22 kB	7.22 kB	✓

Client Build Manifests

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_buildManifest.js gzip	61 B	61 B	✓
_buildManife..dule.js gzip	61 B	61 B	✓
Overall change	122 B	122 B	✓

Serverless bundles Overall decrease ✓

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_error.js gzip	289 kB	289 kB	-67 B
404.html gzip	1.45 kB	1.45 kB	✓
hooks.html gzip	1.08 kB	1.08 kB	✓
index.js gzip	289 kB	289 kB	-51 B
link.js gzip	319 kB	320 kB	⚠️ +461 B
routerDirect.js gzip	316 kB	316 kB	-42 B
withRouter.js gzip	316 kB	316 kB	-631 B
Overall change	1.53 MB	1.53 MB	-330 B

Commit: 68c05ef

ijjk · 2020-02-16T01:25:59Z

Stats from current PR

Default Server Mode

General

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
buildDuration	11.9s	12.4s	⚠️ +452ms
nodeModulesSize	52.7 MB	52.7 MB	✓

Client Bundles (main, webpack, commons)

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
main-HASH.js gzip	5.14 kB	5.14 kB	✓
webpack-HASH.js gzip	746 B	746 B	✓
4952ddcd88e7..54d3.js gzip	4.68 kB	4.68 kB	✓
commons.HASH.js gzip	4.06 kB	4.06 kB	✓
de003c3a9d30..4e43.js gzip	16.2 kB	16.2 kB	✓
framework.HASH.js gzip	39.1 kB	39.1 kB	✓
Overall change	70 kB	70 kB	✓

Client Bundles (main, webpack, commons) Modern

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
main-HASH.module.js gzip	4.14 kB	4.14 kB	✓
webpack-HASH..dule.js gzip	746 B	746 B	✓
4952ddcd88e7..dule.js gzip	5.56 kB	5.56 kB	✓
de003c3a9d30..dule.js gzip	15.1 kB	15.1 kB	✓
framework.HA..dule.js gzip	39.1 kB	39.1 kB	✓
Overall change	64.7 kB	64.7 kB	✓

Legacy Client Bundles (polyfills)

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
polyfills-HASH.js gzip	4.76 kB	4.76 kB	✓
Overall change	4.76 kB	4.76 kB	✓

Client Pages

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_app.js gzip	1.15 kB	1.15 kB	✓
_error.js gzip	4.07 kB	4.07 kB	✓
hooks.js gzip	779 B	779 B	✓
index.js gzip	222 B	222 B	✓
link.js gzip	2.89 kB	2.89 kB	✓
routerDirect.js gzip	283 B	283 B	✓
withRouter.js gzip	282 B	282 B	✓
Overall change	9.68 kB	9.68 kB	✓

Client Pages Modern

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_app.module.js gzip	576 B	576 B	✓
_error.module.js gzip	3.06 kB	3.06 kB	✓
hooks.module.js gzip	371 B	371 B	✓
index.module.js gzip	212 B	212 B	✓
link.module.js gzip	2.46 kB	2.46 kB	✓
routerDirect..dule.js gzip	273 B	273 B	✓
withRouter.m..dule.js gzip	272 B	272 B	✓
Overall change	7.22 kB	7.22 kB	✓

Client Build Manifests

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_buildManifest.js gzip	61 B	61 B	✓
_buildManife..dule.js gzip	61 B	61 B	✓
Overall change	122 B	122 B	✓

Rendered Page Sizes

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
index.html gzip	1.03 kB	1.03 kB	✓
link.html gzip	1.04 kB	1.04 kB	✓
withRouter.html gzip	1.03 kB	1.03 kB	✓
Overall change	3.11 kB	3.11 kB	✓

Serverless Mode (Decrease detected ✓)

General

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
buildDuration	13s	13.2s	⚠️ +128ms
nodeModulesSize	52.7 MB	52.7 MB	✓

Client Bundles (main, webpack, commons)

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
main-HASH.js gzip	5.14 kB	5.14 kB	✓
webpack-HASH.js gzip	746 B	746 B	✓
4952ddcd88e7..54d3.js gzip	4.68 kB	4.68 kB	✓
commons.HASH.js gzip	4.06 kB	4.06 kB	✓
de003c3a9d30..4e43.js gzip	16.2 kB	16.2 kB	✓
framework.HASH.js gzip	39.1 kB	39.1 kB	✓
Overall change	70 kB	70 kB	✓

Client Bundles (main, webpack, commons) Modern

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
main-HASH.module.js gzip	4.14 kB	4.14 kB	✓
webpack-HASH..dule.js gzip	746 B	746 B	✓
4952ddcd88e7..dule.js gzip	5.56 kB	5.56 kB	✓
de003c3a9d30..dule.js gzip	15.1 kB	15.1 kB	✓
framework.HA..dule.js gzip	39.1 kB	39.1 kB	✓
Overall change	64.7 kB	64.7 kB	✓

Legacy Client Bundles (polyfills)

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
polyfills-HASH.js gzip	4.76 kB	4.76 kB	✓
Overall change	4.76 kB	4.76 kB	✓

Client Pages

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_app.js gzip	1.15 kB	1.15 kB	✓
_error.js gzip	4.07 kB	4.07 kB	✓
hooks.js gzip	779 B	779 B	✓
index.js gzip	222 B	222 B	✓
link.js gzip	2.89 kB	2.89 kB	✓
routerDirect.js gzip	283 B	283 B	✓
withRouter.js gzip	282 B	282 B	✓
Overall change	9.68 kB	9.68 kB	✓

Client Pages Modern

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_app.module.js gzip	576 B	576 B	✓
_error.module.js gzip	3.06 kB	3.06 kB	✓
hooks.module.js gzip	371 B	371 B	✓
index.module.js gzip	212 B	212 B	✓
link.module.js gzip	2.46 kB	2.46 kB	✓
routerDirect..dule.js gzip	273 B	273 B	✓
withRouter.m..dule.js gzip	272 B	272 B	✓
Overall change	7.22 kB	7.22 kB	✓

Client Build Manifests

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_buildManifest.js gzip	61 B	61 B	✓
_buildManife..dule.js gzip	61 B	61 B	✓
Overall change	122 B	122 B	✓

Serverless bundles Overall decrease ✓

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_error.js gzip	289 kB	289 kB	⚠️ +214 B
404.html gzip	1.45 kB	1.45 kB	✓
hooks.html gzip	1.08 kB	1.08 kB	✓
index.js gzip	289 kB	289 kB	⚠️ +66 B
link.js gzip	319 kB	318 kB	-374 B
routerDirect.js gzip	316 kB	316 kB	-37 B
withRouter.js gzip	316 kB	316 kB	-104 B
Overall change	1.53 MB	1.53 MB	-235 B

Commit: 8f1f5df

ijjk · 2020-02-16T05:16:20Z

Stats from current PR

Default Server Mode

General

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
buildDuration	11.3s	11.2s	-162ms
nodeModulesSize	52.7 MB	52.7 MB	✓

Client Bundles (main, webpack, commons)

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
main-HASH.js gzip	5.14 kB	5.14 kB	✓
webpack-HASH.js gzip	746 B	746 B	✓
4952ddcd88e7..54d3.js gzip	4.68 kB	4.68 kB	✓
commons.HASH.js gzip	4.06 kB	4.06 kB	✓
de003c3a9d30..4e43.js gzip	16.2 kB	16.2 kB	✓
framework.HASH.js gzip	39.1 kB	39.1 kB	✓
Overall change	70 kB	70 kB	✓

Client Bundles (main, webpack, commons) Modern

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
main-HASH.module.js gzip	4.14 kB	4.14 kB	✓
webpack-HASH..dule.js gzip	746 B	746 B	✓
4952ddcd88e7..dule.js gzip	5.56 kB	5.56 kB	✓
de003c3a9d30..dule.js gzip	15.1 kB	15.1 kB	✓
framework.HA..dule.js gzip	39.1 kB	39.1 kB	✓
Overall change	64.7 kB	64.7 kB	✓

Legacy Client Bundles (polyfills)

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
polyfills-HASH.js gzip	4.76 kB	4.76 kB	✓
Overall change	4.76 kB	4.76 kB	✓

Client Pages

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_app.js gzip	1.15 kB	1.15 kB	✓
_error.js gzip	4.07 kB	4.07 kB	✓
hooks.js gzip	779 B	779 B	✓
index.js gzip	222 B	222 B	✓
link.js gzip	2.89 kB	2.89 kB	✓
routerDirect.js gzip	283 B	283 B	✓
withRouter.js gzip	282 B	282 B	✓
Overall change	9.68 kB	9.68 kB	✓

Client Pages Modern

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_app.module.js gzip	576 B	576 B	✓
_error.module.js gzip	3.06 kB	3.06 kB	✓
hooks.module.js gzip	371 B	371 B	✓
index.module.js gzip	212 B	212 B	✓
link.module.js gzip	2.46 kB	2.46 kB	✓
routerDirect..dule.js gzip	273 B	273 B	✓
withRouter.m..dule.js gzip	272 B	272 B	✓
Overall change	7.22 kB	7.22 kB	✓

Client Build Manifests

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_buildManifest.js gzip	61 B	61 B	✓
_buildManife..dule.js gzip	61 B	61 B	✓
Overall change	122 B	122 B	✓

Rendered Page Sizes

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
index.html gzip	1.03 kB	1.03 kB	✓
link.html gzip	1.04 kB	1.04 kB	✓
withRouter.html gzip	1.03 kB	1.03 kB	✓
Overall change	3.11 kB	3.11 kB	✓

Serverless Mode (Decrease detected ✓)

General

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
buildDuration	11.9s	12.7s	⚠️ +763ms
nodeModulesSize	52.7 MB	52.7 MB	✓

Client Bundles (main, webpack, commons)

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
main-HASH.js gzip	5.14 kB	5.14 kB	✓
webpack-HASH.js gzip	746 B	746 B	✓
4952ddcd88e7..54d3.js gzip	4.68 kB	4.68 kB	✓
commons.HASH.js gzip	4.06 kB	4.06 kB	✓
de003c3a9d30..4e43.js gzip	16.2 kB	16.2 kB	✓
framework.HASH.js gzip	39.1 kB	39.1 kB	✓
Overall change	70 kB	70 kB	✓

Client Bundles (main, webpack, commons) Modern

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
main-HASH.module.js gzip	4.14 kB	4.14 kB	✓
webpack-HASH..dule.js gzip	746 B	746 B	✓
4952ddcd88e7..dule.js gzip	5.56 kB	5.56 kB	✓
de003c3a9d30..dule.js gzip	15.1 kB	15.1 kB	✓
framework.HA..dule.js gzip	39.1 kB	39.1 kB	✓
Overall change	64.7 kB	64.7 kB	✓

Legacy Client Bundles (polyfills)

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
polyfills-HASH.js gzip	4.76 kB	4.76 kB	✓
Overall change	4.76 kB	4.76 kB	✓

Client Pages

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_app.js gzip	1.15 kB	1.15 kB	✓
_error.js gzip	4.07 kB	4.07 kB	✓
hooks.js gzip	779 B	779 B	✓
index.js gzip	222 B	222 B	✓
link.js gzip	2.89 kB	2.89 kB	✓
routerDirect.js gzip	283 B	283 B	✓
withRouter.js gzip	282 B	282 B	✓
Overall change	9.68 kB	9.68 kB	✓

Client Pages Modern

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_app.module.js gzip	576 B	576 B	✓
_error.module.js gzip	3.06 kB	3.06 kB	✓
hooks.module.js gzip	371 B	371 B	✓
index.module.js gzip	212 B	212 B	✓
link.module.js gzip	2.46 kB	2.46 kB	✓
routerDirect..dule.js gzip	273 B	273 B	✓
withRouter.m..dule.js gzip	272 B	272 B	✓
Overall change	7.22 kB	7.22 kB	✓

Client Build Manifests

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_buildManifest.js gzip	61 B	61 B	✓
_buildManife..dule.js gzip	61 B	61 B	✓
Overall change	122 B	122 B	✓

Serverless bundles Overall decrease ✓

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_error.js gzip	289 kB	289 kB	⚠️ +72 B
404.html gzip	1.45 kB	1.45 kB	✓
hooks.html gzip	1.08 kB	1.08 kB	✓
index.js gzip	290 kB	289 kB	-631 B
link.js gzip	319 kB	319 kB	⚠️ +549 B
routerDirect.js gzip	316 kB	316 kB	-103 B
withRouter.js gzip	316 kB	315 kB	-901 B
Overall change	1.53 MB	1.53 MB	-1.01 kB

Commit: 2159a78

ijjk · 2020-02-16T05:19:25Z

Stats from current PR

Default Server Mode

General

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
buildDuration	11.1s	11s	-20ms
nodeModulesSize	52.7 MB	52.7 MB	✓

Client Bundles (main, webpack, commons)

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
main-HASH.js gzip	5.14 kB	5.14 kB	✓
webpack-HASH.js gzip	746 B	746 B	✓
4952ddcd88e7..54d3.js gzip	4.68 kB	4.68 kB	✓
commons.HASH.js gzip	4.06 kB	4.06 kB	✓
de003c3a9d30..4e43.js gzip	16.2 kB	16.2 kB	✓
framework.HASH.js gzip	39.1 kB	39.1 kB	✓
Overall change	70 kB	70 kB	✓

Client Bundles (main, webpack, commons) Modern

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
main-HASH.module.js gzip	4.14 kB	4.14 kB	✓
webpack-HASH..dule.js gzip	746 B	746 B	✓
4952ddcd88e7..dule.js gzip	5.56 kB	5.56 kB	✓
de003c3a9d30..dule.js gzip	15.1 kB	15.1 kB	✓
framework.HA..dule.js gzip	39.1 kB	39.1 kB	✓
Overall change	64.7 kB	64.7 kB	✓

Legacy Client Bundles (polyfills)

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
polyfills-HASH.js gzip	4.76 kB	4.76 kB	✓
Overall change	4.76 kB	4.76 kB	✓

Client Pages

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_app.js gzip	1.15 kB	1.15 kB	✓
_error.js gzip	4.07 kB	4.07 kB	✓
hooks.js gzip	779 B	779 B	✓
index.js gzip	222 B	222 B	✓
link.js gzip	2.89 kB	2.89 kB	✓
routerDirect.js gzip	283 B	283 B	✓
withRouter.js gzip	282 B	282 B	✓
Overall change	9.68 kB	9.68 kB	✓

Client Pages Modern

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_app.module.js gzip	576 B	576 B	✓
_error.module.js gzip	3.06 kB	3.06 kB	✓
hooks.module.js gzip	371 B	371 B	✓
index.module.js gzip	212 B	212 B	✓
link.module.js gzip	2.46 kB	2.46 kB	✓
routerDirect..dule.js gzip	273 B	273 B	✓
withRouter.m..dule.js gzip	272 B	272 B	✓
Overall change	7.22 kB	7.22 kB	✓

Client Build Manifests

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_buildManifest.js gzip	61 B	61 B	✓
_buildManife..dule.js gzip	61 B	61 B	✓
Overall change	122 B	122 B	✓

Rendered Page Sizes

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
index.html gzip	1.03 kB	1.03 kB	✓
link.html gzip	1.04 kB	1.04 kB	✓
withRouter.html gzip	1.03 kB	1.03 kB	✓
Overall change	3.11 kB	3.11 kB	✓

Serverless Mode (Decrease detected ✓)

General

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
buildDuration	12.3s	12.4s	⚠️ +136ms
nodeModulesSize	52.7 MB	52.7 MB	✓

Client Bundles (main, webpack, commons)

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
main-HASH.js gzip	5.14 kB	5.14 kB	✓
webpack-HASH.js gzip	746 B	746 B	✓
4952ddcd88e7..54d3.js gzip	4.68 kB	4.68 kB	✓
commons.HASH.js gzip	4.06 kB	4.06 kB	✓
de003c3a9d30..4e43.js gzip	16.2 kB	16.2 kB	✓
framework.HASH.js gzip	39.1 kB	39.1 kB	✓
Overall change	70 kB	70 kB	✓

Client Bundles (main, webpack, commons) Modern

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
main-HASH.module.js gzip	4.14 kB	4.14 kB	✓
webpack-HASH..dule.js gzip	746 B	746 B	✓
4952ddcd88e7..dule.js gzip	5.56 kB	5.56 kB	✓
de003c3a9d30..dule.js gzip	15.1 kB	15.1 kB	✓
framework.HA..dule.js gzip	39.1 kB	39.1 kB	✓
Overall change	64.7 kB	64.7 kB	✓

Legacy Client Bundles (polyfills)

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
polyfills-HASH.js gzip	4.76 kB	4.76 kB	✓
Overall change	4.76 kB	4.76 kB	✓

Client Pages

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_app.js gzip	1.15 kB	1.15 kB	✓
_error.js gzip	4.07 kB	4.07 kB	✓
hooks.js gzip	779 B	779 B	✓
index.js gzip	222 B	222 B	✓
link.js gzip	2.89 kB	2.89 kB	✓
routerDirect.js gzip	283 B	283 B	✓
withRouter.js gzip	282 B	282 B	✓
Overall change	9.68 kB	9.68 kB	✓

Client Pages Modern

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_app.module.js gzip	576 B	576 B	✓
_error.module.js gzip	3.06 kB	3.06 kB	✓
hooks.module.js gzip	371 B	371 B	✓
index.module.js gzip	212 B	212 B	✓
link.module.js gzip	2.46 kB	2.46 kB	✓
routerDirect..dule.js gzip	273 B	273 B	✓
withRouter.m..dule.js gzip	272 B	272 B	✓
Overall change	7.22 kB	7.22 kB	✓

Client Build Manifests

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_buildManifest.js gzip	61 B	61 B	✓
_buildManife..dule.js gzip	61 B	61 B	✓
Overall change	122 B	122 B	✓

Serverless bundles Overall decrease ✓

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_error.js gzip	290 kB	289 kB	-791 B
404.html gzip	1.45 kB	1.45 kB	✓
hooks.html gzip	1.08 kB	1.08 kB	✓
index.js gzip	289 kB	290 kB	⚠️ +826 B
link.js gzip	319 kB	319 kB	-80 B
routerDirect.js gzip	316 kB	315 kB	-761 B
withRouter.js gzip	315 kB	315 kB	⚠️ +34 B
Overall change	1.53 MB	1.53 MB	-772 B

Commit: 7bcf391

ijjk · 2020-02-16T05:24:03Z

Stats from current PR

Default Server Mode

General

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
buildDuration	13.2s	13.4s	⚠️ +237ms
nodeModulesSize	52.7 MB	52.7 MB	✓

Client Bundles (main, webpack, commons)

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
main-HASH.js gzip	5.14 kB	5.14 kB	✓
webpack-HASH.js gzip	746 B	746 B	✓
4952ddcd88e7..54d3.js gzip	4.68 kB	4.68 kB	✓
commons.HASH.js gzip	4.06 kB	4.06 kB	✓
de003c3a9d30..4e43.js gzip	16.2 kB	16.2 kB	✓
framework.HASH.js gzip	39.1 kB	39.1 kB	✓
Overall change	70 kB	70 kB	✓

Client Bundles (main, webpack, commons) Modern

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
main-HASH.module.js gzip	4.14 kB	4.14 kB	✓
webpack-HASH..dule.js gzip	746 B	746 B	✓
4952ddcd88e7..dule.js gzip	5.56 kB	5.56 kB	✓
de003c3a9d30..dule.js gzip	15.1 kB	15.1 kB	✓
framework.HA..dule.js gzip	39.1 kB	39.1 kB	✓
Overall change	64.7 kB	64.7 kB	✓

Legacy Client Bundles (polyfills)

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
polyfills-HASH.js gzip	4.76 kB	4.76 kB	✓
Overall change	4.76 kB	4.76 kB	✓

Client Pages

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_app.js gzip	1.15 kB	1.15 kB	✓
_error.js gzip	4.07 kB	4.07 kB	✓
hooks.js gzip	779 B	779 B	✓
index.js gzip	222 B	222 B	✓
link.js gzip	2.89 kB	2.89 kB	✓
routerDirect.js gzip	283 B	283 B	✓
withRouter.js gzip	282 B	282 B	✓
Overall change	9.68 kB	9.68 kB	✓

Client Pages Modern

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_app.module.js gzip	576 B	576 B	✓
_error.module.js gzip	3.06 kB	3.06 kB	✓
hooks.module.js gzip	371 B	371 B	✓
index.module.js gzip	212 B	212 B	✓
link.module.js gzip	2.46 kB	2.46 kB	✓
routerDirect..dule.js gzip	273 B	273 B	✓
withRouter.m..dule.js gzip	272 B	272 B	✓
Overall change	7.22 kB	7.22 kB	✓

Client Build Manifests

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_buildManifest.js gzip	61 B	61 B	✓
_buildManife..dule.js gzip	61 B	61 B	✓
Overall change	122 B	122 B	✓

Rendered Page Sizes

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
index.html gzip	1.03 kB	1.03 kB	✓
link.html gzip	1.04 kB	1.04 kB	✓
withRouter.html gzip	1.03 kB	1.03 kB	✓
Overall change	3.11 kB	3.11 kB	✓

Serverless Mode (Decrease detected ✓)

General

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
buildDuration	14.4s	15.1s	⚠️ +701ms
nodeModulesSize	52.7 MB	52.7 MB	✓

Client Bundles (main, webpack, commons)

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
main-HASH.js gzip	5.14 kB	5.14 kB	✓
webpack-HASH.js gzip	746 B	746 B	✓
4952ddcd88e7..54d3.js gzip	4.68 kB	4.68 kB	✓
commons.HASH.js gzip	4.06 kB	4.06 kB	✓
de003c3a9d30..4e43.js gzip	16.2 kB	16.2 kB	✓
framework.HASH.js gzip	39.1 kB	39.1 kB	✓
Overall change	70 kB	70 kB	✓

Client Bundles (main, webpack, commons) Modern

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
main-HASH.module.js gzip	4.14 kB	4.14 kB	✓
webpack-HASH..dule.js gzip	746 B	746 B	✓
4952ddcd88e7..dule.js gzip	5.56 kB	5.56 kB	✓
de003c3a9d30..dule.js gzip	15.1 kB	15.1 kB	✓
framework.HA..dule.js gzip	39.1 kB	39.1 kB	✓
Overall change	64.7 kB	64.7 kB	✓

Legacy Client Bundles (polyfills)

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
polyfills-HASH.js gzip	4.76 kB	4.76 kB	✓
Overall change	4.76 kB	4.76 kB	✓

Client Pages

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_app.js gzip	1.15 kB	1.15 kB	✓
_error.js gzip	4.07 kB	4.07 kB	✓
hooks.js gzip	779 B	779 B	✓
index.js gzip	222 B	222 B	✓
link.js gzip	2.89 kB	2.89 kB	✓
routerDirect.js gzip	283 B	283 B	✓
withRouter.js gzip	282 B	282 B	✓
Overall change	9.68 kB	9.68 kB	✓

Client Pages Modern

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_app.module.js gzip	576 B	576 B	✓
_error.module.js gzip	3.06 kB	3.06 kB	✓
hooks.module.js gzip	371 B	371 B	✓
index.module.js gzip	212 B	212 B	✓
link.module.js gzip	2.46 kB	2.46 kB	✓
routerDirect..dule.js gzip	273 B	273 B	✓
withRouter.m..dule.js gzip	272 B	272 B	✓
Overall change	7.22 kB	7.22 kB	✓

Client Build Manifests

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_buildManifest.js gzip	61 B	61 B	✓
_buildManife..dule.js gzip	61 B	61 B	✓
Overall change	122 B	122 B	✓

Serverless bundles Overall decrease ✓

	zeit/next.js canary	chibicode/next.js update-create-next-app-readme	Change
_error.js gzip	289 kB	289 kB	-53 B
404.html gzip	1.45 kB	1.45 kB	✓
hooks.html gzip	1.08 kB	1.08 kB	✓
index.js gzip	290 kB	289 kB	-280 B
link.js gzip	319 kB	319 kB	-591 B
routerDirect.js gzip	316 kB	315 kB	-1.18 kB
withRouter.js gzip	316 kB	315 kB	-819 B
Overall change	1.53 MB	1.53 MB	-2.92 kB

Commit: e23d111

timneutkens · 2020-02-16T15:00:21Z

💯

chibicode added 2 commits February 15, 2020 16:14

Rename to README-template.md

b7ccd50

Add yarn scripts

68c05ef

chibicode added 2 commits February 15, 2020 17:18

Rewrite CNA README

1c860ac

Forgot zeit link

8f1f5df

chibicode requested review from lfades and timneutkens February 16, 2020 04:56

chibicode marked this pull request as ready for review February 16, 2020 04:56

chibicode requested review from ijjk and Timer as code owners February 16, 2020 04:56

chibicode changed the title ~~Update create-next-app README~~ Simplify create-next-app README Feb 16, 2020

chibicode added 4 commits February 15, 2020 21:10

Simplify

2159a78

Update deploy doc

7bcf391

Just link to the doc

995ac18

page is reloaded

e51b045

chibicode added 2 commits February 15, 2020 21:16

reload → update

37e53ae

Deploy updates

e23d111

timneutkens approved these changes Feb 16, 2020

View reviewed changes

timneutkens merged commit 9cfc09e into vercel:canary Feb 16, 2020

This was referenced Mar 13, 2020

[Snyk] Upgrade next from 9.2.1 to 9.2.2 pixeldrew/hero-masq#10

Closed

[Snyk] Upgrade @next/mdx from 9.0.5 to 9.2.2 shahinalzahrani/docs#1

Open

This was referenced Mar 22, 2020

[Snyk] Upgrade next from 9.1.5 to 9.2.2 evantahler/next-static-hosting#3

Merged

[Snyk] Upgrade next from 9.2.1 to 9.2.2 grouparoo/next-plugins-example#3

Merged

vercel locked as resolved and limited conversation to collaborators Jan 31, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Simplify create-next-app README #10545

Simplify create-next-app README #10545

chibicode commented Feb 16, 2020 •

edited

Loading

ijjk commented Feb 16, 2020

ijjk commented Feb 16, 2020

ijjk commented Feb 16, 2020

ijjk commented Feb 16, 2020

ijjk commented Feb 16, 2020

timneutkens commented Feb 16, 2020

Simplify create-next-app README #10545

Simplify create-next-app README #10545

Conversation

chibicode commented Feb 16, 2020 • edited Loading

ijjk commented Feb 16, 2020

Stats from current PR

ijjk commented Feb 16, 2020

Stats from current PR

ijjk commented Feb 16, 2020

Stats from current PR

ijjk commented Feb 16, 2020

Stats from current PR

ijjk commented Feb 16, 2020

Stats from current PR

timneutkens commented Feb 16, 2020

chibicode commented Feb 16, 2020 •

edited

Loading