Skip to content

Update docs to the KCD README pattern #131

@spences10

Description

@spences10

README pattern

Optimal README layout from Kent Dodds source:

  1. Title + tagline + logo?
  2. Badges
  3. The problem
  4. The solution
  5. TOC
  6. Installation
  7. Usage
  8. FAQ
  9. Inspiration
  10. Alternatives
  11. Contributors
  12. License

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions