Documentation for REST Generator in Intro to Generators in Readme

[CoderMayhem]

Documentation on using REST API Generator "Rest" and many other newly added generators is missing from the Readme. It would be useful to add them.

[leondz]

agree! thanks

[leondz]

Let's update this. we don't want to make README.md a monolithic doc describing all of garak; we also don't want to have to maintain README.md too much. Let's make this generator's entry in README.md point to the reference docs for RESTGenerator, which is autopopulated from docs in the class source, rest.py, and then:

• [ ] A) make this update and leave this as a pattern going forward, i.e. that content in README.md should defer to the docs
• [ ] B) get alerting if rtd doc builds fail, because this desyncs the codebase and the published docs C) consider class docs as the authoritative place for documentation, and ensure that ref docs read from it