Skip to content

Repo is missing a quick start section #22

Open
@thomashoneyman

Description

@thomashoneyman

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 completed 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.

Metadata

Metadata

Assignees

No one assigned

    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