This is a motherfucking README.

And it still doesn't tell you what the fuck this thing does.

Seriously, what were you trying to accomplish?

I opened your repo to find out what your project does. Instead I got six build-status badges, a license shield, a code-coverage percentage nobody asked for, and a banner asking me to sponsor you before I know what I'm sponsoring. Then "Prerequisites," which assumes I already have four tools installed, an opinion about package managers, and apparently a working relationship with your Discord. Then "Quick Start," eleven steps long, four of which are secretly "go read the wiki."

I don't know what your project does. I've read four screens and I still don't know what your project does.

Here's what a README is supposed to do

Tell me what it is. Tell me why I'd want it. Tell me how to start using it. That's it. That's the whole job. Three sentences could do this. You wrote three thousand words and somehow skipped all three.

You did this to yourself

Nobody forced you to write "leverages a novel middleware architecture to facilitate seamless data orchestration." You typed that. On purpose. Sober, presumably. Somewhere in your head, "it saves you from writing the boring code twice" turned into a sentence that requires a dictionary and a moment of quiet reflection. That's not a documentation problem. That's a you problem.

The jargon isn't making you look smart

It's making me close the tab. Every acronym you don't explain, every term you assume I already know, every sentence that reads like it was written for the version of me that already understands this project? That's a reader you just lost. Congratulations, I guess.

The ASCII art isn't hiding anything

You've got a forty-line ASCII logo at the top of your README. It renders like a waveform of a scream. On mobile it wraps into abstract art. Nobody has ever finished reading ASCII art and thought, "ah, now I understand the middleware." It's not a brand. It's a curtain. And there is nothing behind it.

Screenshots. Of what?

Six screenshots before the first sentence. Three GIFs of a demo I can't identify. A dark-mode/light-mode split screen for an app whose purpose remains a mystery. This is a menu that's entirely photos of strangers chewing. I don't want to see the thing. I want to know what the thing is for. One sentence. Before the pixels.

"Documentation"

Ah yes, the Documentation section. One line. One link. The link goes to a wiki. The wiki hasn't been updated since the package was named something else. There's a "Getting Started" page in there that begins with "first, migrate from v1." There is no v1. There has never been a v1.

And you closed the issue

The worst part is that you know. There's an issue in your tracker, two years old, titled "README doesn't say what this does," and you closed it with "PRs welcome." Somebody volunteered to fix your front door and you made them do a code review first.

Your project might be incredible. I'll never know. Neither will anyone else. I closed the tab.

Fine. At least use this, you overcomplicated fuck: npx skills add armedev/skills/dumb-readme. It reads your actual code and writes a DUMB_README.md a five-year-old could follow. Your beautiful unreadable original stays untouched.