/readme-generator

Command line application to generate professional README file for development projects using NPM Inquirer.

Primary LanguageJavaScriptMIT LicenseMIT

README Generator

MIT badge

Description

Command line application to generate professional README file for development projects. Application built using Node.js and the Inquirer package.

Table of Contents

Installation

Clone the repo to your local machine in Git OR download to your machine and extract files from .zip file. Then, install the Inquirer package using npm i command.

Usage

Run with Node.js – invoke in terminal using node index.js command.

Walkthrough

https://youtu.be/niFmGMtSA0o

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this Software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions.

Contributions

To contribute, fork the repository, add descriptive commits, and then open a pull request back to the original repo describing your proposed changes.

Tests

Run the following commands to test the application: node index.js

Questions?

Reach out to me on GitHub (Captain63) or email me at stephen.a.rodd@gmail.com