RichardLitt/standard-readme

Improve documentation on using badges in README

Open

#157 opened on Nov 7, 2025

View on GitHub
 (3 comments) (1 reaction) (0 assignees)Shell (5,239 stars) (2,483 forks)batch import
enhancementhelp wanted

Description

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!

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
MarkdownREADME structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Examine the current README at https://github.com/RichardLitt/standard readme/blob/master/README.md, specifically the 'Badges' section. Review common badge services like Shields.io and their Markdown syntax. Look at the comments in issue #157 for any additional suggestions. Provide example code snippets and guidelines for badge placement and sizing.