Next.js: Readme should mention `public` is an experimental feature

[dbachrach]

Bug report

Describe the bug

The README contains this line:

To serve static files from the root directory you can add a folder called public and reference those files from the root, e.g: /robots.txt.

However #7771 made this feature experimental. It should either be removed from the readme or the experimental flag to enable it should be mentioned.

To Reproduce

Read README (https://github.com/zeit/next.js)

Expected behavior

Should not include experimental features or should mention that the feature is experimental.

Screenshots

N/A

System information

N/A

Additional context

N/A

[c0b41]

same as middleware #7647

[pkrawc]

@Timer Will this be marked as experimental or made a production feature? I don't want to move to this from having a static build with zeit until I don't have to worry about this not changing, but this is a perfect fit for service workers since they need to be served from the root path.

[Timer]

@pkrawc It's marked experimental until we deprecate static/, but it's stable for all intents and purposes. You can opt-into it and use it if you'd like (the migration will quite literally be to move ./static/ into the ./public/ folder).

[jkjustjoshing]

Is there a place all the current experimental features are listed/documented?

[Timer]

No @jkjustjoshing, you can find them in the code, though!

The two I'd suggest to try in your apps are experimental: { publicDirectory: true, granularChunks: true }!