Skip to content

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

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, and a quick start with a minimal usage example.

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. machines is one example of a library with a quick start.

At least we could show in brief what you might use the library for, even if it's only one or two tiny examples.

Additional context
See the Governance repository for more information about requirements in the Contributors organization.

Metadata

Metadata

Assignees

No one assigned

    Labels

    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