README missing installation, example usage, and contributing sections

[amoeba]

This Issue relates to the corresponding JOSS review for this software: openjournals/joss-reviews#339

The JOSS guidelines require a high-level overview of the statement of need, installation, and example usage. In addition, guidelines for contributors are also required, though the guidelines don't specify where (I suggest the README).

I realize that you've written much of this information in your linked documentation (which is great btw) but, to meet the JOSS guidelines, could you in-line some of this information? The README.md in the root of the repo already meets the statement of need but otherwise could use the other sections.

Thanks

[pjamesjoyce]

Sure no problem - I've added the corresponding sections to README.md in the latest commit (4a357b7 ).

I'll leave this issue open for the time being in case you think I need to add more detail.

Cheers

[amoeba]

LGTM. Thanks!