README From Reality

Generate a README draft from the files, scripts, routes, and config that actually exist in a repository.

Why

Most generated README files sound confident but ignore the real project. README From Reality scans the repo first, then writes a practical draft based on real signals.

Features

• Detects package scripts and package manager
• Detects common stacks like Node, TypeScript, React, Vite, Next.js, Express, Spring, Python, Docker, and GitHub Actions
• Finds environment variables from .env.example and process.env.NAME
• Extracts common Express/Fastify, Next.js App Router, and Spring mapping routes
• Generates a project tree
• Writes to README.generated.md by default so your real README is safe
• Runs with Node built-in modules only

Install

npm install -g readme-from-reality

For local development:

git clone https://github.com/YOUR_NAME/readme-from-reality.git
cd readme-from-reality
npm install

Usage

Generate a draft for the current repo:

readme-reality .

Write to a custom file:

readme-reality . --output README.generated.md

Print to terminal:

readme-reality . --stdout

Overwrite README.md only when you mean it:

readme-reality . --output README.md --force

Example Output

See examples/sample-generated-readme.md.

Development

npm test
npm run sample

Roadmap

• More route detectors
• Framework-specific README templates
• --check mode for CI
• Optional badges
• Config file support

License

MIT