https://github.com/ncastaldi/hw9-readme_generator

Assignment: Professional ReadMe Generator
https://github.com/ncastaldi/hw9-readme_generator

Last synced: about 1 month ago
JSON representation

Assignment: Professional ReadMe Generator

• Host: GitHub
• URL: https://github.com/ncastaldi/hw9-readme_generator
• Owner: ncastaldi
• License: mit
• Created: 2021-01-07T21:00:23.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2021-01-08T22:15:18.000Z (over 5 years ago)
• Last Synced: 2025-01-05T21:09:03.746Z (over 1 year ago)
• Language: JavaScript
• Size: 13 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Assignment: Professional ReadMe Generator

## Description

For this assignment, we were tasked with creating a command-line application that dynamically generates a professional README.md file from a user's input using the [Inquirer package](https://www.npmjs.com/package/inquirer).

This app

## Table of Contents

- [Installation](#installation)

- [Usage](#usage)

- [License](#license)

- [Badges](#badges)

## Installation

Download the following files to a local folder:

- index.js

- package.json

- util/generateMarkdown.js

Run `npm install` command from a Bash command line to install dependencies.

## Usage

Run `node index.js` command from a Bash command line to start app.

Video of App: ![App Walkthrough GIF](./assets/recordingOfApp.gif)

GitHub Repository: [https://github.com/ncastaldi/hw9-readme_generator](https://github.com/ncastaldi/hw9-readme_generator)

## License

MIT License

Copyright (c) [2021] [Nathan Castaldi]

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:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.

## Badges

[![GitHub license](https://img.shields.io/github/license/ncastaldi/hw9-readme_generator?style=for-the-badge)](https://github.com/ncastaldi/hw9-readme_generator/blob/main/LICENSE)