What is easyreadme?

Easy README is not an app you run yourself, it is a skill for Claude Code that teaches the AI a repeatable process for writing good README files based only on facts it can actually find in your project. Instead of guessing at features, commands, or licenses that do not exist, the skill instructs Claude to check the real project files first and mark anything it cannot confirm as a TODO rather than inventing it. The skill follows a five step process. First it clarifies who the README is for and what tone and location it should have. Then it extracts real facts from your project, looking at manifests, documentation, scripts, continuous integration files, deployment files, environment variable examples, and any images or media already in the repo. Next it picks a README structure appropriate to your project type, whether that is a command line tool, a library, an AI application, a backend API, a full product, or a self hosted app, drawing on a small library of proven README patterns. It then drafts the README using only verified facts, and finally it runs a validation pass that checks for broken local links, missing recommended sections, incorrect package commands, media path problems, and leftover TODO markers. The project bundles two small Python scripts to support this: one that analyzes a project folder and reports its structure and metadata as JSON, and one that validates a finished README against the actual project. Everything else is Markdown reference material, including the pattern library, quality checklist, and base template that Claude reads while working. This is meant for developers who already use Claude Code or a compatible agent runtime such as Cursor, Codex CLI, Gemini CLI, or OpenCode, and who want documentation generated or improved for a real repository without fabricated details. It can be installed with a single command through the Skills CLI, copied manually into a skills folder, or uploaded to Claude as a zip file.