RichardLitt/standard-readme
Improve documentation on using badges in README
クローズ
#157 opened on 2025/11/07
enhancementhelp wanted
Repository metrics
- Stars
- (5,239 個のスター)
- PR merge metrics
- (平均マージ 2h 3m) (30d で 1 merged 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!