Skip to content

Add README file #12

Description

@joewxboy

This README needs better information:

  1. Front matter
  2. Shields - license should match LICENSE file
  3. Description
  4. Prerequisites
  5. Installation
  6. Usage
  7. Advanced Details
  8. Authors - should match MAINTAINERS.md

See examples of good README.md files:

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomers

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions