/readme-generator

Creates a README.md file based on a short quiz

Primary LanguageJavaScript

README Generator

License: MIT

Description

This application creates a professional README file by asking you questions from the command line and formatting the answers.

The README that you are reading right now was created using the the README Generator!

Table of Contents

  1. Installation
  2. Usage
  3. License
  4. Contributing
  5. Questions

Installation

All you need to do is download the package.

Usage

Open up terminal, navigate to where the downloaded folder is and type the following command:

node index.js

Answer the questions that pop up in the terminal window and once finished a new index.html file will be created. Try opening it in a browser to see the results!

MIT License

A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.

Contributing

You are welcome to contribute to this project. Please submit a pull request.

Questions

GitHub profile: https://github.com/fawltya

If you have any additional questions feel free to email me