README.md Generator

Table of Contents

• Description
• License
• Usage
• Installation
• Test
• Contributors
• Contact
• Credits

Description

• The README.md generator is a node.js application that interact with the user’s command line to create a README.md. The purpose of this application is to give the user an alternative and more efficient way to create a README.md file.

License

• 

Usage

• The application is mainly used for developers working on their repositories and want to create a README.md file that is formatted to appeal to other developers and users that will be using their application. It organizes the main information about the aspects of the application and presents it so that it is easy to follow.

Installation

1. Select the folder of the README.md generator while in your command line.
2. Once you're in the folder, write "npm start" in your Command Line.
3. Follow the prompts.
4. Your result should be a completed README.md.

Test

• You are required to have node.js, inquirer, fs, and util to use this application. You will need to do an npm install in you command line after this is cloned and then follow the installation instructions in order to test the application.

• Video Demo: https://drive.google.com/file/d/1pvJ0sNjyQxQaDVqhC12Ez7Hgm4ehmUqk/view

Contributors

• Ibrahim Riyami

Contact

• https://github.com/iariyami

• iariyami@ncsu.edu

Credits

• nodejs.org
• https://www.npmjs.com/package/inquirer#question