License

generateREADME

Description

An application that streamlines one's ReadMe documentation, by using a base format and adding pertinent information.

Table of Contents

Installation

To install necessary dependencies, run the following command:

npm i

Usage

Use the following sequence from our command line to generate your README file. First, run node index.js to start the prompts that will aquire the necessary information. The prompts will be: What is your GITHUB username, what is your email, brief description of your project, desired license, how to install/test the program, and how to use your described program.

License

This project is licensed under the terms of the APACHE 2.0 license.

Contributing

If you have a questions about the project or would like to contribute, please contact me through the methods listed under "Contact".

Tests

To run tests, run the following command:

node index.js

Contact

If you have any questions about the repo, open an issue or contact me at devkhanna@outlook.com. You can find more of my work at khannadk.