Skip to content

Repository doesn't have a quick start section in the README #54

Open
@JordanMartinez

Description

@JordanMartinez

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.

Metadata

Metadata

Assignees

Labels

good first issueFirst-time contributors who are looking to help should work on these issues.type: documentationImprovements or additions to documentation.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions