Roast My README: Real AI Roasts of Famous GitHub READMEs

April 16, 2026 · 6 min read

We put three of the most widely-used open source projects through our AI README roaster. No repo is too famous to get called out. Here are the actual roasts — unedited — and what they teach you about your own README.

React

"This README is basically a lovingly crafted link farm to react.dev — because why summarize anything when you can just punt every question to 'go read the docs elsewhere'? The Installation section reads like a choose-your-own-adventure where all paths lead away from this file. That truncated sentence at the very end suggests someone rage-quit mid-edit."

What this means for your README: Don't make users leave to understand what you built. A 3-line quick start — real code, real output — should live in the first 20 lines of your README.

Express

"This README has a Table of Contents that links to a Table of Contents — very meta, very useful, thanks dad. The Features list is so vague it could describe wet cardboard: 'Robust routing' — cool story bro, literally every router does that. There's a Quick Start that cuts off mid-sentence like the README got tired and went home."

What this means for your README: "Robust routing" and "fast performance" are filler. Name the specific thing that makes your project different. If you can't — that's the real problem, and the README is just revealing it.

Vue 2

"Slapping 'END OF LIFE' at the top is like wearing a neon sign that says 'don't start here' — but then you've got six paragraphs of badges, sponsor logos, and business-as-usual README theater below it, sending the mixed message of 'we're dead but also please admire our CI/CD pipeline.' You're still actively recruiting sponsors and linking to upgrade guides like you're fighting for custody."

What this means for your README: The top of your README sets the tone immediately. If the most important thing about your project is its status (deprecated, alpha, stable), say it first and say it clearly.

What patterns show up across all three

No quick start in the first screen. All three require you to scroll or click away before you understand how to use them.
Vague feature descriptions. None of them say "here's the one thing that makes this different from the alternatives."
Assumes too much context. All three assume you already know why you're looking at this project.

If React, Express, and Vue have these problems — your README almost certainly does too. The question is whether yours has the millions of users to survive them.

What a roast tells you that a style guide doesn't

Style guides say "add a quick start section." A roast tells you that your current quick start is three links to external docs that all 404. Style guides say "describe your project." A roast tells you that your description could apply to 400 other projects on npm and that's why nobody stars it.

Specificity is the difference. The roast forces it.

🔥 Roast My README

Paste your README. Get the same treatment React got — specific, brutal, useful. Free preview, $2 full report.

Try it free →