/READMEgenerator

Create a command-line application that dynamically generates a README.md from a user's input.

Primary LanguageJavaScript

README Generator

npm

Description

This command-line application dynamically generates a "README.md" file from the user's input.

Table of Contents

Installation

To install, please run the following command in terminal:

npm i

Usage

Fork this repo, and clone to your local machine. If you want to retain this README.md file, then you need to rename the file as it will be overwritten when the application is executed. Open the user terminal and execute the installation command. Next, execute the test command. Then execute the command "node index.js" within the terminal to begin the command-line prompts.

License

This project is licensed under the MIT license.

Contributing

Go to GitHub repo and create a pull request or email the developer directly. See Questions.

Tests

To test installation, run the following command in terminal:

npm test

Questions

If you have any questions about the repo, open an issue or contact Hlsorrells directly at hlsorrells.dev@gmail.com.