generate readme programatically

[Zamiell]

i think that the readme should be generated automatically by a script, so that bugs like #1263 will never happen again.

in my own eslint plugin, i use a custom script to accomplish this: https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-plugin-isaacscript/scripts/generateReadme.mts

so I think you could do something similar with this plugin.

[brettz9]

Yeah, would be good to add it to our generateRule script, thanks.

[JoshuaKGoldberg]

How about onboarding to eslint-doc-generator? It's pretty commonly used in the ecosystem, and quite handy.