Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ezaiger/professional-readme-generator

Module 9 Challenge Assignment - A command-line application that dynamically generates a professional README.md file from a user's input.
https://github.com/ezaiger/professional-readme-generator

inquirer javascript readme-generator

Last synced: about 2 months ago
JSON representation

Module 9 Challenge Assignment - A command-line application that dynamically generates a professional README.md file from a user's input.

Awesome Lists containing this project

README

        

# Professional README Generator

## License
[![License: MPL 2.0](https://img.shields.io/badge/License-MPL_2.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)

Mozilla Public License 2.0 (MPL-2.0)
Further resources on Mozilla Public License 2.0 (MPL-2.0) - Please click on the license badge above for more information.

## Description
A command-line application that dynamically creates a professional README.md file

## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)
- [Contributing](#contributing)
- [Tests](#tests)
- [Questions](#questions)

## Installation
- Create a .gitignore file and include: node_modules/, .DS_Store/ and package-lock.json.
- Initialize the npm project by entering 'npm init -y' in the command line.
- Install Inquirer by entering 'npm i [email protected]' in the command line.
- Invoke the application by entering the following command: node index.js

## Usage
Follow this link for the walkthrough video of the application demonstration.

## Contributing
Starter code provided by Xander Rapstine and Grace Choi with coding-boot-camp. Refactored code provided by ezaiger.

## Tests
N/A

## Questions
My GitHub Profile

If you have additional questions, you can reach me via email