# kefranabg/readme-md-generator

📄 CLI that generates beautiful README.md files

Repository: https://github.com/kefranabg/readme-md-generator
Canonical: https://ross.abutalabs.com/products/readme-md-generator
Homepage: https://www.npmjs.com/package/readme-md-generator
Language: JavaScript
License: MIT
License Family: permissive
Topics: readme, readme-template, readme-md, readme-generator, readme-badges, generator, cli
Last push: 2022-09-20T10:09:51+00:00

## Health v2 (maintenance only)
Score: 23/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 0, release rhythm 8, longevity 100
- inputs: {"age_days": 2648, "days_push": 1443, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 11129, forks 1368 (observed 2026-08-28T04:10:46.171769+00:00)

## What it is
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
- artifact type: cli-tool
- maturity: maintenance
- function: cli, documentation, markdown, templating, developer-tools
- domain: developer-tools, documentation
- platform: cli, cross-platform
- tags: readme-generator, npm, ejs-templates, project-scaffolding, interactive-prompts, command-line, nodejs

## Member repositories
- kefranabg/readme-md-generator (main) score 23

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:10:46.171769+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T17:16:46.627304+00:00, confidence not recorded.
  - readme: https://github.com/kefranabg/readme-md-generator (fetched 2026-08-28T04:10:46.171769+00:00, sha b97e980efb84)
  - registry_npm: https://registry.npmjs.org/readme-md-generator (fetched 2026-08-29T08:15:43.525801+00:00, sha 4b4f11026263)
- Data as of 2026-08-30T08:39:29.467469+00:00.