docs: refresh README.md with explainer and options types - Githubissues

ArnaudBarre / eslint-plugin-react-refresh

Validate that your components can safely be updated with Fast Refresh

MIT License

222 stars 15 forks source link

docs: refresh README.md with explainer and options types #63

Closed JoshuaKGoldberg closed 2 days ago

JoshuaKGoldberg commented 2 days ago

Fixes #28. Fixes #62.

"Refreshes" (ha) the README.md:

Adds a top-level explainer for what "fast refresh" / "hot reloading" are with a link to react-refresh
Explicitly calls out in a few places that there's just the one only-export-components rule
Moved Flat config to the primary location and Legacy config to its own section
Adds basic types & default options docs for options, similar to how they're shown in typescript-eslint.io/rules