Skip to content

brhestir/readme-generator

Repository files navigation

https://github.com/brhestir/readme-generator/blob/main/README.md

Parse, transform & generate README instructions with NodeJS and Markdown

https://github.com/brhestir/readme-generator/blob/main/LICENSE GitHub top language

Table of Contents

Description

This CLI app generates a high-quality README.md composed from user response's to a series of questions common to README.md generation for a new project.

GitHub Repo

Setup & Usage Walkthrough Video

Installation

npm install

Usage

node index.js

Licence

https://github.com/brhestir/readme-generator/blob/main/LICENSE

Contributing

Contributions welcome!

Test

After running index.js, open a separate shell session and run:

npm test

Questions

Questions are welcome, contact me on GitHub or in the comments.