kefranabg/readme-md-generator

Health v2 · maintenance only

Adoption not part of the score

11129 stars · 1368 forks observed · 2026-08-28

What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-29, confidence not recorded

A Node.js CLI tool that generates polished README.md files for projects by interactively asking questions and suggesting defaults from package.json and git configuration. It supports custom EJS templates and can run via npx without installation.

Use cases

• generate a readme for my github project
• create a professional README.md quickly
• bootstrap documentation for a new npm package
• generate readme with badges from package.json
• use a custom readme template
• scaffold project documentation from git config

When to choose

• you want a well-structured README without writing it from scratch
• your project has a package.json with good metadata to seed defaults
• you want an interactive prompt-driven generator with custom EJS template support

When to avoid

• you need fully automated, non-interactive README generation in CI
• your project is not JavaScript/Node-based and lacks package.json metadata
• you need actively maintained tooling - the last release was in 2022

Facets

cli-tool · maturity maintenance

cli documentation markdown templating developer-tools developer-tools documentation cli cross-platform readme-generator npm ejs-templates project-scaffolding interactive-prompts command-line nodejs

Member repositories

For agents

markdown · JSON · MCP: product_card(name="kefranabg/readme-md-generator")