readmecraft
v1.0.0
Published
Generate a README.md from your package.json in seconds
Maintainers
Readme
quick-readme
Generate a README.md from your package.json in seconds.
Installation
npx quick-readmeOr install globally:
npm install -g quick-readmeUsage
# Generate README.md in current directory
npx quick-readme
# Preview without writing
npx quick-readme --preview
# Overwrite existing README
npx quick-readme --force
# Custom output path
npx quick-readme --output docs/README.mdWhat it generates
- Title and description from
nameanddescription - npm badges (version + license)
- Installation instructions (detects CLI vs library)
- Usage examples
- Scripts table
- Dependencies list
- Keywords
- License section
- Contributing section
- Funding link (if specified in package.json)
License
MIT
If this saves you time, buy me a coffee!
