Skip to content

thusted/README_Generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

README_Generator

Description

This is a command-line application that dynamically generates a professional README.md from a user's input, using the Inquirer package. A command-line application will allow for quick and easy generation of a project README to get started quickly. This will allow a project creator to spend more time working on finishing the project and less time creating a good README.

Table of Contents

Installation

Clone the GitHub repository and copy to local machine. Upon opening index.js in terminal, first run npm i inquirer and npm i fs commands, then run node index.js to begin application

Usage

To use, just be sure to install inquirer and fs dependencies.

Licenses

This application is covered under MIT License.

Contributing

I contributed to this project.

Tests

To test functionality, simply run node index.js in terminal.

Questions

For any further questions, feel free to contact me on GitHub at http://github.com/thusted or send me an email at: tiana.husted@gmail.com.

Demo of Application

https://www.youtube.com/watch?v=CjvqWjj4pEY&feature=youtu.be

About

This is a command-line application that dynamically generates a professional README.md from a user's input, using the Inquirer package. A command-line application will allow for quick and easy generation of a project README to get started quickly. This will allow a project creator to spend more time working on finishing the project and less time…

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors