DEV Community

Manish112233
Manish112233

Posted on

I built a CLI that keeps README.md in sync with code (GitHub doesn’t)

README files always go out of sync.

GitHub only creates a README template.
It doesn’t update documentation when code changes.

So I built a small CLI called readme-fast.

What it does:

  • Updates only safe sections of README.md
  • Never touches your manual content
  • Runs locally, no config, no cloud

Command:
npx readme-fast

GitHub repo:

https://github.com/Manish112233/readme-fast

It’s open-source and free.
Update: I also wrote about why README.md goes out of sync and how to fix it

👉 https://dev.to/manish112233/why-readmemd-always-goes-out-of-sync-and-how-i-fixed-it

Top comments (0)