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

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

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/mauryiv/readme-generator
• Owner: MauryIV
• Created: 2024-02-26T05:04:32.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-02-26T23:44:16.000Z (11 months ago)
• Last Synced: 2024-10-15T05:23:36.479Z (3 months ago)
• Language: JavaScript
• Size: 28.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


# README Generator 



## Description

This project is to make creating a readme easier. You will be prompted by the command line to answer a series of questions in order to fill out necessary information for a professional readme. Once complete a readme will be generated for you!

## Table of Contents

- [Title](#title)

- [Description](#description)

- [Badges](#badges)

- [Visuals](#visuals)

- [Installation](#installation)

- [Usage](#usage)

- [Tests](#tests)

- [Questions](#questions)

- [Roadmap](#roadmap)

- [Contributing](#contributing)

- [Authors and Acknowledgment](#acknowledgment)

- [License](#license)

- [Project Status](#status)



## Badges

![Maury Hughes IV](https://img.shields.io/badge/Maury%20Hughes%20IV-5A2BE2)

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



## Installation

User does need to install dependencies listed in package.json.



## Usage

This code can be used to help keep your readmes professional simplify the process for future use.



## Visuals

[Video Walkthrough](https://drive.google.com/file/d/1mXW7Jh0GVSyPllepBFKyu7zdTiVCwrPw/view)



## Tests

This project was tested on my local VSCode integrated terminal with Node.js. When running tests, make sure you are putting in necessary formatting for a md file. This Readme is actually created using the project.



## Questions

If you have any questions about the contents. Please feel free to reach out!

Here is my [Github](https://github.com/MauryIV) as well as my email .



## Roadmap

I am happy where this project is currently, but always open to improvements. 



## Contributing

Am always open to contributions and input. Feel free to reach out if you have any.



## Authors and Acknowledgment

I wrote most all of this code, but do have to tribute the DU bootcamp for providing a base code and the knowledge to complete this.



## License

MIT License © 2024 Maury Hughes IV

Please refer to this link, [License: MIT](https://opensource.org/licenses/MIT) for more information.



## Project Status

Completed.

[back to top](#title)