README.md usually becomes outdated after a few commits.
We change code:
- add dependencies
- change entry points
- refactor folders
But README stays the same.
GitHub only creates a README template.
It doesn’t keep documentation in sync.
I wanted a simple solution where:
- README updates automatically
- manual sections stay untouched
- no config or cloud is needed
So I built a small CLI that updates only safe sections of README.md.
Run:
npx readme-fast
It’s open-source and works with existing projects.
Related: I built a CLI that keeps README.md in sync with code.
Top comments (0)