Repository doesn't have a quick start section in the README
Opened this issue · 5 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. While the test/Examples.purs file exists, it's not in readme form and something simpler should exist as a quick start.
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.
May I work on this?
Go for it!
I'd recommend reading through this pull request for extra context on the philosophy of this library.
Thank you for the advice!!
Oh no, I wrote this in the wrong tab 😅 I meant that for the issue of the same name on the Nullable repository:
purescript-contrib/purescript-nullable#31
That PR is not relevant to this library. Sorry about that!