Document usage and a typical workflow in `README.md`.

Question

Document usage and a typical workflow in `README.md`.

amunra opened this issue 2 years ago · 2 comments

amunra commented 2 years ago

Answer 1 · 2023-01-19T10:48:21.000Z

May be relevant:

https://maven.apache.org/plugin-developers/plugin-documenting.html

Answer 2 · 2023-01-20T12:15:48.000Z

The "Features" section isn't properly written:

@amyshwang mentioned that the "Features" section of the README should not mix verbs as much. E.g. consider rephrasing "Calls .." to "Calling ..".

We should probably cut down on the amount of detail here and make it just 3 bullet points and leave the rest of the detail to proper docs once they're written.