/ReadMe-Generator

Primary LanguageJavaScriptMIT LicenseMIT

ReadMe-Generator

Licenses

License: MIT

Description

This application is designed with the purpose of maximizing efficincy in creating README.md files so that creators can focus on their projects. The generated ReadMe.md includes well thought out aspects including licenses, and a dynamic table of contents.

How To

DEMO

To use this application, users should have node.js installed. Additionally, users should install the npm Inquirer package. This application generates the README.md from the terminal command-line.

  • Step one: Open the terminal and type 'node index.js'.

  • Step two: Answer the prompts. prompts

  • Step three: Open the generated RREADME.md README.md

Credits & Resources

I used many examples from the UT resources provided in class and github resources.