Generates a comprehensive README.md by analyzing your project structure and code.
README Scaffolder analyzes your project's directory structure, package manifest, entry points, and existing documentation to generate a thorough README.md. It produces sections for project description, installation, usage, configuration, API reference, contributing guidelines, and license.
The skill detects your tech stack (language, framework, package manager, test runner) and generates installation and usage instructions specific to your setup. It reads existing README content and merges rather than overwrites, preserving any custom sections you've written.
Code examples are generated from your actual source files — the skill finds exported functions, CLI commands, and configuration options and creates realistic usage snippets. Requires no external services. Reads project files and writes README.md.