Skip to content

Write a README #31

@Seamooo

Description

@Seamooo

Documentation is effectively non-existant at this stage. Constructing a README that communicates the project's status and usage will be a good start for making it accessible.

Ideally the PR to resolve this issue should:

  • create a badge for CI status
  • create a badge for version
  • show the CLI help
  • give examples for usage

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions