RichardLitt/standard-readme

Improve documentation on using badges in README

已關閉

#157 建立於 2025年11月7日

 (3 則留言) (1 個反應) (0 位負責人)Shell (2,483 個分叉)batch import
enhancementhelp wanted

倉庫指標

星標
 (5,239 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

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!

貢獻者指南