RichardLitt/standard-readme

Improve documentation on using badges in README

Open

#157 创建于 2025年11月7日

在 GitHub 查看
 (3 评论) (1 反应) (0 负责人)Shell (5,239 star) (2,483 fork)batch import
enhancementhelp wanted

描述

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!

贡献者指南

Improve documentation on using badges in README · RichardLitt/standard-readme#157 | Good First Issue