Update README.md

[vixero-dev]

The existing code from the docs will result in Cannot find module 'eslint-plugin-react/configs/recommended'. Updated the README page with a working example.

[codecov]

Codecov Report

Merging #3485 (93dbceb) into master (865ed16) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #3485   +/-   ##
=======================================
  Coverage   97.57%   97.57%           
=======================================
  Files         129      129           
  Lines        9192     9192           
  Branches     3331     3331           
=======================================
  Hits         8969     8969           
  Misses        223      223           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[ljharb]

Why are you just removing parts of the readme that were added in #3429?

[ljharb]

Please note, just like everywhere on github, you should be reading docs for the tagged version you're using, not just what's on main/master. For npm packages, read the published readme, not the repo's readme.

[vixero-dev]

Why are you just removing parts of the readme that were added in #3429?

I am proposing this change because according to eslint docs, shareable configs are configured in a different way than provided in the current readme.

Please note, just like everywhere on github, you should be reading docs for the tagged version you're using, not just what's on main/master.

Would you please give a more detailed explanation, or suggest some documents? My assumption is that the master is the latest stable version. Why is my assumption incorrect?

For npm packages, read the published readme, not the repo's readme.

Thank you for pointing that out. I assumed those readme's were the same.

[ljharb]

That assumption is incorrect - on almost every repo on github - whenever there are unpublished changes, as there are here.

[ljharb]

This seems fine to close, since the readme on master is correct. Happy to reopen after the next release if there's still something that needs changing.