/design-docs:user-docs-create-readme

To generate a README from package.json, this skill analyzes your directory structure and package configurations to produce a context-aware documentation skeleton. It extracts codebase-specific content to instantly bootstrap a professional README file.

Yes, you can use this README generator for a monorepo root or sub-package. It features smart detection to automatically identify your project structure type and generates documentation tailored to that specific configuration.

Yes, a valid package.json file is required within the target directory to bootstrap project documentation. This dependency ensures accurate detection of your project type and enables the generation of codebase-specific content.

The best way to scaffold a README for a new module is using an automated documentation generator. This approach eliminates manual effort by detecting your project structure and populating a README skeleton with appropriate badges and structural documentation.

A limitation of automatic README scaffolding is its strict requirement for a valid package.json file in the target local repository. Without this configuration file, the tool cannot accurately detect project types or generate documentation skeletons.