Section coverage
Which expected sections are present, required ones counted separately.
Charts appear here once you run an analysis.
README Analyzer BETA
Analyze your README for structure, completeness and best practices. Paste Markdown or point us at a repository.
Free to use
No registration
Privacy-first
Paste your README Markdown or point us at a GitHub repository.
Analysis is performed on our servers. We do not store or share your data.
Visual analytics
How the document reads to someone new
Section coverage, where a first-time reader stops, what the findings are, and how deep the structure runs.
Onboarding path
The order a new reader needs, and the first step that is missing.
Charts appear here once you run an analysis.
Findings by category
What the analysis actually flagged, grouped by kind.
Charts appear here once you run an analysis.
Heading depth
How many levels the reader has to keep track of.
Charts appear here once you run an analysis.
Use cases
When to analyze a README
The README is the first and often only documentation anyone reads.
Before open sourcing
A public repository with no install or licence section costs contributors before it costs anything else.
Onboarding a new team member
Read the document the way someone without your context does, and find where they would stop.
Auditing many repositories
The same rule set applied to every repository gives a comparable score instead of an opinion.
Scope and limits
Rule-based, repeatable, local
The same text always produces the same score, and nothing is sent to a language model.
Heuristics you can predict
Sections are detected from headings and well-known cues; the score is a fixed weighting of those sections plus a handful of structure checks. Links are counted, never requested, so this tool never claims a link is broken or alive. Nothing is analyzed by a third-party AI service, and no repository content is retained after the report is built.
Help
FAQ
What a README score usually prompts.
My README is good but scores low. How?
The score rewards a predictable structure, because that is what a stranger navigates by. A brilliant document with no installation heading still costs a newcomer time, and that is what the missing section reports.
Are the links checked?
No. They are counted so the structure checks can see whether the document links out at all. Nothing is requested, so nothing here says a link works or is broken.
Is my code or README sent to an AI service?
No. The analysis is a deterministic parser on our own server. The text is read, scored and discarded.
Can I analyze a private repository?
Not by URL, since the fetch is unauthenticated. Paste the Markdown instead: it is processed in exactly the same way.
Axios vs Fetch and Ky: Which HTTP Client Should You Use?
Axios became the default HTTP client for many JavaScript teams because it offered a clean API before Fetch became the standard browser primitive. Today, many teams can use native Fetch directly or pick Ky, a small wrapper that adds convenience without the full weight of Axios. The right choice depends on whether you actually need Axios-specific features such as interceptors and existing wrappers, or whether a lighter, more modern request layer fits your app better.
Read article
Redux Toolkit vs Zustand: Which State Library Is Better?
Redux Toolkit is the modern standard for writing Redux logic and remains a strong choice for large applications with strict patterns. Zustand is a smaller, simpler state management library with a hooks-first API and much less boilerplate. The decision is not about which library is more popular. It is about whether your team needs explicit enterprise structure or a lightweight store that stays out of the way.
Read article
Webpack vs Vite: Should Enterprise Teams Switch?
Webpack remains deeply embedded in enterprise frontend applications because it is powerful, configurable, and battle-tested. Vite represents the modern development experience: fast startup, native ESM workflows, simpler configuration, and strong framework support. The decision is not simply old versus new. Enterprise teams need to decide whether the flexibility of Webpack is still worth its complexity for the codebase they actually run today.
Read article