Repository doesn't have a quick start section in the README
Opened this issue · 2 comments
Is your change request related to a problem? Please describe.
As described in the documentation section of the Library Guidelines, Contributors libraries are expected to have in their README a short summary of the library's purpose, installation instructions, a quick start with a minimal usage example, and links to the documentation and contributing guide.
This library currently doesn't have a quick start in the README.
Describe the solution you'd like
The library needs a quick start section after the installation instructions. argonaut-codecs is one example of a library with a quick start.
Additional context
See the Governance repository for more information about requirements in the Contributors organization.
Do you have any suggestions for what the quick start sections should be? What a minimal parse / print example might be? Maybe there's something in the tests we could use to suggest a quick start for whomever wants to take on this issue.
I think this will be easier to do once I update #50 to use un-newtyped records.