readme-md-generator

readme-md-generator is a command-line tool that helps developers create README files for their projects by walking them through a series of questions. It reads information already present in your project, such as the package name, version, description, author, license, and repository link from a package.json file and from your Git configuration. It then pre-fills answers to questions using that information, so you are not typing things from scratch.

The tool runs directly from the terminal using a single command and produces a formatted README.md file at the end of the process. If you want to skip the interactive questions entirely, you can pass a flag to accept all the suggested defaults automatically.

For developers who want a different layout than the built-in template, the tool supports custom templates written in a format called EJS, which lets you define the structure of the README however you like while still having the tool fill in the project details.

This is primarily useful for open-source developers or teams who frequently start new projects and want a consistent, well-structured README without spending time formatting one by hand. The generated output includes sections for project description, usage instructions, contributing guidelines, and license information.

The project is MIT licensed and was built by Franck Abgrall.