README-generator

# Welcome to readme-generator! 0.1.0

## Description

A CLI to quickly and easily generate a templated README file based on your project item inputs. Now you can focus on the project itself!

Technologies used

• node.js
• npm file system
• package.json
• template literals
• inquirer npm package

### Demo

Deployed Application: https://kassimariemc.github.io/README-generator/

## Table of Contents

• Installation
• Usage
• License
• Contributing
• Tests
• Questions

## Installation

Clone the repo to your local machine using git@github.com:kassimariemc/README-generator.git
Then $ npm install

## Usage

Just run the following command at the root of the cloned file and answer the questions

$ node index.js



The original README.md file will now be generated as the README for your personal project and produce the below.



Just copy and paste to your desired project.

## License

Copyright © 2020 @kassimariemc.
This project is MIT licensed.

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.

## Tests

See demo!

## Questions

@kassimariemc
Please email me with any questions! kassi.mcintosh@gmail.com

---

This README was generated with ♥ by readme-generator