Skip to content

Add project badges to README #17

@darylwright

Description

@darylwright

Add badges to the README.md to better communicate the status and type of project, and also stats such as code coverage percentages. There is also a badge that communicates that a project uses conventional commits. Some ideas below for badges:

  • code coverage
  • license
  • conventional commits
  • build status
  • latest release
  • code of conduct?
  • sponsorship?
  • crypto (https://en.cryptobadges.io/)

Use https://shields.io/ to generate badges that don't have an existing template somewhere.

Good example projects for badges and README formats:

Metadata

Metadata

Assignees

No one assigned

    Labels

    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