RichardLitt/standard-readme resource
A standard style for README files observed · 2026-08-28
Health v2 · maintenance only
75/100
- Activity 88
- Release rhythm 43
- Longevity 100
How is this computed?
round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10) — computed 2026-09-03. Adoption (stars, forks) is never an input.
- gap_med: n/a
- age_days: 3974
- days_rel: 168
- days_push: 77
- n_releases_24m: 1
Adoption not part of the score
6352 stars · 2512 forks observed · 2026-08-28
What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-29, confidence not recorded
Standard Readme is a specification and style guide for writing consistent, well-structured README files, primarily aimed at open-source libraries. It includes the spec itself, a badge, example READMEs, and links to a companion linter and generator.
Use cases
- standardize readme format across an organization's repositories
- write a good readme for a new open-source library
- lint and validate readme structure
- generate a readme from a template
- learn best practices for documenting open-source projects
When to choose
- you maintain multiple open-source repositories and want consistent documentation
- you're starting a new library and want a proven readme structure
- you want a lintable readme spec with tooling support
When to avoid
- you need full API documentation tooling rather than readme structure
- your project requires a highly custom readme format
- you need end-user application documentation rather than a library readme
Facets
learning-resource · maturity stable
documentation markdown linter documentation developer-tools cross-platform readme readme-standard specification docs style-guide open-source nodejs
1 source
- readme: https://github.com/RichardLitt/standard-readme · fetched 2026-08-28 · 7167326e7b9e
Member repositories
| Repository | Role | Health v2 |
|---|---|---|
| RichardLitt/standard-readme | main | 75 |
For agents
markdown · JSON · MCP: product_card(name="RichardLitt/standard-readme")
Data as of 2026-08-30T08:39:29.467469+00:00 · Report a problem