Node.js - Inquirer README Generator

Module 9 UNC Coding Bootcamp Challenge - CLI README Generator

This application utilizes the inquirer NPM package to capture user input through the command line interface and generate a personalized README file.

Installation

Clone the repository:

git clone [email protected]:t-starkw/me-read.git

Install the required dependencies:

npm install

Run the project in your local browser:

node index.js

Usage

To generate your own README for your next project or application, simply run the command the node index.js in your preferred terminal and answer the prompts that follow.

Need extra help? Watch this short Demo Video
View the sample README here

Meta

Tessa Starkweather – LinkedIn – [email protected]

View my profile – GitHub

Distributed under the MIT license. See LICENSE for more information.

Contributing

1. Fork it (https://github.com/t-starkw/me-read/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request

License

https://opensource.org/licenses/MIT