DOC: README requirements for PyOpenSci

[frank1010111]

Issue with current documentation:

The review for PyOpenSci sets out a few extra requirements for the README. This includes

• Descriptive links for all vignettes
• A package demonstration
• how the package compares to other similar packages and/or how it relates to other packages in the scientific ecosystem.
• Citation information

Idea or request for content:

I would suggest adding three or four things to the readme

• links to two or three of these examples
• A worked through simple example (could be one of those examples you've already got)
• Elaborating on the comparison to other THz analysis tools that you mentioned in the paper's statement of need in the readme
• An easy-to-copy citation in a code block near the end

For bonus points, it might be worth your while to include a CITATION.cff to the root of the project, though that's going above and beyond the requirements for the review

Additional context (e.g. screenshots, GIFs)

No response

[jsdodge]

Thanks for those suggestions, @frank1010111 . To clarify, since we expect to have the software published in JOSS at the end of the review, is there a provisional citation that you would recommend before that?

[frank1010111]

Yes, since JOSS will require it anyway, I would suggest a following this example to get a Zenodo citation.