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

Published: (December 19, 2025 at 08:37 AM EST)
3 min read
Source: Dev.to

Source: Dev.to

Forem Feed

Follow new Subforems to improve your feed


DEV Community

DEV Community Logo
DEV Community Main Image

DEV Community – A space to discuss and keep up software development and manage your software career.


Future

Future Logo
Future Main Image

Future – News and discussion of science and technology such as AI, VR, cryptocurrency, quantum computing, and more.


Open Forem

Open Forem Logo
Open Forem Main Image

Open Forem – A general discussion space for the Forem community. If it doesn’t have a home elsewhere, it belongs here.


Music Forem

Music Forem Logo
Music Forem Main Image

Music Forem – From composing and gigging to gear, hot music takes, and everything in between.


Vibe Coding Forem

Vibe Coding Forem Logo
Vibe Coding Forem Main Image

Vibe Coding Forem – Discussing AI software development, and showing off what we’re building.


Security Forem

Security Forem Logo
Security Forem Main Image

Security Forem – Your central hub for all things security. From ethical hacking and CTFs to GRC and career development, for beginners and pros alike.


Golf Forem

Golf Forem Logo
Golf Forem Main Image

(No description provided in the original content.)


Additional Communities (Logos only)

  • Gamers Forem Logo
  • Popcorn Movies and TV Logo
  • DUMB DEV Community Logo
  • Design Community Logo

(These entries only included a logo in the original markup; no further details were provided.)

What Was Changed

AreaBeforeAfter
Spacing & blank linesInconsistent, many empty lines and stray spaces.Removed unnecessary whitespace; added a single blank line between logical sections.
Section headingsNone – the content was a flat list of images and text.Added clear headings (##, ###) to delineate each community.
GroupingImages, links, and descriptions were scattered.Grouped each community’s logo, main image, link, and description together in a consistent block.
Horizontal rulesNone.Inserted --- between major sections for visual separation.
List of logo‑only communitiesLogos appeared as isolated blocks.Consolidated them into a concise bullet list labeled “Additional Communities (Logos only)”.
ReadabilityHard to scan due to raw HTML‑like markup.Reformatted into clean, standard Markdown that renders nicely on any platform.
Preserved contentAll original images, URLs, and text remain unchanged.No content was removed or altered; only the markup was tidied.
ConsistencyMixed indentation and stray HTML‑style tags.Uniform Markdown syntax throughout.

Additional Cleaned Markdown

Golf Forem

Golf Forem – A community of golfers and golfing enthusiasts


Crypto Forem

Crypto Forem Logo
Crypto Forem Main Image

Crypto Forem – A collaborative community for all things Crypto—from Bitcoin to protocol development and DeFi to NFTs and market analysis.


Forem Core

Forem Core Logo
Forem Core Main Image

Forem Core – Discussing the core Forem open‑source software project — features, bugs, performance, self‑hosting.


Parenting

Parenting Logo
Parenting Main Image

Parenting – A place for parents to share the joys, challenges, and wisdom that come from raising kids. We’re here for them and for each other.


Maker Forem

Maker Forem Logo
Maker Forem Main Image

Maker Forem – A community for makers, hobbyists, and professionals to discuss Arduino, Raspberry Pi, 3D printing, and much more.


HMPL.js Forem

HMPL.js Forem Logo
HMPL.js Forem Main Image

HMPL.js Forem – For developers using HMPL.js to build fast, lightweight web apps. A space to share projects, ask questions, and discuss server‑driven templating.

Back to Blog

Related posts

Read more »

Project Structure Checker

What it does PSX auto‑detects the project type Node, Go, etc. and runs a set of rules to ensure the repository has the essential files. If something’s missing...