neylonmc / README.md-Generator

A command-line application allows for quick and easy generation of a project README.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Node.js and ES6+ Homework: Good README Generator

A quality README is important for any open source project on GitHub. This command-line application allows for quick and easy generation of a project README. This allows a user to spend more time working on finishing the project and less time creating a good, quality README.

Table of Contents

Installation

You will need Node.js to run this application.

Usage

The README Generator is a command-line application. To get started, this user will type node index in their command line and a series of questions will appear (as seen below).

Screenshot of the code.

Once the user inputs their answers, the answers will appear in the userREADME file and be in a markdown format.

GIF of application

License

License

Contact

  • GitHub: neylonmc
  • Email: neylonmc@gmail.com

About

A command-line application allows for quick and easy generation of a project README.


Languages

Language:JavaScript 100.0%