https://github.com/gurleyryan/readme-generator

Module 9: Node.JS Challenge - Professional README Generator
https://github.com/gurleyryan/readme-generator

Last synced: about 1 month ago
JSON representation

Module 9: Node.JS Challenge - Professional README Generator

• Host: GitHub
• URL: https://github.com/gurleyryan/readme-generator
• Owner: gurleyryan
• License: mit
• Created: 2024-02-19T20:23:17.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-02-22T20:38:15.000Z (9 months ago)
• Last Synced: 2024-02-22T21:47:39.967Z (9 months ago)
• Language: JavaScript
• Size: 27.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Professional README Generator

![License: MIT License](https://img.shields.io/badge/License-MIT-green.svg)

## Table of Contents

- [About](#about)

- [Installation](#installation)

- [Usage](#usage)

- [Contributing](#contributing)

- [Credits](#credits)

- [License](#license)

## About

Built a command-line application that dynamically generates a professional README.md file from a user's input.

## Installation

You must first clone this repo. Once the repo is downloaded, open it in VS Code. 


Install Node.js modules, including the Inquirer.js dependency, using the terminal command:

```console

npm i

```

Run the application using the terminal command:

```console

node index.js

```

## Usage

Type in your answers to the prompted questions. 


Select the license using the arrow keys. 


[Link to demonstration video](https://drive.google.com/file/d/18jzMA4Rswo_ptyFehnSRr1d_KgSEer02/view)

## Contributing

Contributors: 


- [Ryan Gurley](https://github.com/gurleyryan)

## Credits

External Sources: 


- [Node.js](https://nodejs.org/en) 


- [Inquirer](https://www.npmjs.com/package/inquirer) 


- [Shields.io](https://shields.io/)

## License

Please refer to the [LICENSE](https://github.com/gurleyryan/readme-generator?tab=MIT-1-ov-file) in the repo.