Skip to content

Improve documentation on using badges in README #157

@himabindu-1614

Description

@himabindu-1614

I was going through the README and noticed that the “Badges” section is mentioned, but I found it a bit unclear on how to actually use them.

It would be super helpful if the docs could explain:

  • Which badge services are commonly used
  • Examples of badges with Markdown syntax
  • Any guidelines for placement or sizing

Right now, the section just briefly mentions badges without showing how to add them, so newcomers might be a bit lost.

It’d be great if a small subsection could be added with example code snippets and some best practices for including badges in a README. Thanks!

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions