https://github.com/kevin-hernandez-garza/read-me

https://github.com/kevin-hernandez-garza/read-me

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/kevin-hernandez-garza/read-me
• Owner: Kevin-Hernandez-Garza
• Created: 2021-10-05T07:29:55.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-10-15T17:40:15.000Z (about 3 years ago)
• Last Synced: 2023-03-11T05:41:24.774Z (almost 2 years ago)
• Language: JavaScript
• Size: 28.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# README Generator

## License

#### License Link 🎫

- [License: Mozilla](https://choosealicense.com/licenses/mpl-2.0/)

#### Badge 🏆

[![Badge](https://img.shields.io/badge/license-Mozilla-brightgreen/)](https://img.shields.io/badge/license-Mozilla-brightgreen/)

## Description 📖

- If you’re looking for a little shortcut when building your README markdown file this is the way to go. This project is built to help the user create a professional looking README.md file in order to save time and be more focused on the project at hand. This project was built with the runtime environment called [Node.js](https://nodejs.org/en/) and a Node Package Manager known as [Inquirer](https://www.npmjs.com/package/inquirer) in oder to capture the user’s input.

## Table of Contents

- [Installation 🛠](#installation)

- [Usage 🎮](#usage)

- [Test 🎬](#test)

- [Contribution 👾](#contribution)

- [Contact 📟](#contact-me/questions)

## Installation

- In order for anyone else to be able to use this project and create their own README.md file you would do the following. 
 - First: [Clone]([email protected]:Kevin-Hernandez-Garza/read-me.git) the Remote Repository 
 -Second: Install [Node.js](https://nodejs.org/en/) 
 -Third: Run the following command in your terminal “node index”.

## Usage

- This can be used by anyone and everyone in order to create a README.md file without spending too much time thinking on how to structure the file. All you have to do is plug in your information with the “inquirer” prompt questions created through to the command line interface.

## Test

[Watch The Demo](https://watch.screencastify.com/v/9hCjYUo2F2ocDPXkD6hV)

## Contribution

This project was successfully built by myself “Kevin Hernandez” and the use of some Google searches and StackOverflow late night questions.

## Contact Me/Questions

- GitHub: [Kevin-Hernandez-Garza](https://github.com/Kevin-Hernandez-Garza)

- Email: [[email protected]](mailto:[email protected])

### © Created with 💜 by Kevin Hernandez!