README-generator

Description

This README-generator can quickly and easy create a high-quality README for any application using a command-line application. The application will accept user input and a README will be dynamically generated containing the following sections:

  • Title of project
  • License badge
  • Description
  • A table of contents that links to each section of the README
  • Installation
  • Usage
  • License
  • Contributing
  • Tests
  • Questions

It is hoped that this will save project creators time and ensure that they can consistently created high-quality READMEs

Usage

This is a command-line application. It can be used by running node on the index.js file

Video

Please see walkthrough video below

Walkthrough.video.webm

Questions

If you have any questions, you can reach me at my GitHub profile: https://github.com/ffionerin