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

Node.js based README generator
https://github.com/krenbot/readme-generator

generator readme-generator readme-template

Last synced: 22 days ago
JSON representation

Node.js based README generator

• Host: GitHub
• URL: https://github.com/krenbot/readme-generator
• Owner: Krenbot
• Created: 2022-10-30T22:30:07.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-07T01:12:21.000Z (about 2 years ago)
• Last Synced: 2024-10-06T02:40:52.395Z (3 months ago)
• Topics: generator, readme-generator, readme-template
• Language: JavaScript
• Homepage:
• Size: 87.9 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# README-generator

Video Demonstration [HERE](https://drive.google.com/file/d/1_8pKNfz9sb8VUOlVZSIO7x9ffQhA0kW_/view?usp=share_link)

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

## Table of Contents

- [Description](#description)

- [Installation](#installation)

- [Usage](#usage)

- [Contribution](#contribution)

- [Tests](#tests)

- [License](#license)

- [Contact](#contact)

## Description:

When creating an open source project on GitHub, it’s important to have a high-quality README for the app. This should include what the app is for, how to use the app, how to install it, how to report issues, and how to make contributions—this last part increases the likelihood that other developers will contribute to the success of the project.

You can quickly and easily generate a README file by using a command-line application to generate one. This allows the project creator to devote more time working on the project.

## Installation:

To install this README generator

1. Clone this repo to your local machine

2. Install [`node.js`](https://nodejs.org/en/)

## Usage:

1. Open main folder in your terminal

2. Use `npm init` and `npm install` to install the 'Inquirer' npm package.

3. Type `node index.js` and answer all questions given.

4. Your README is now finished and resides as `readme.md` in the `dist` folder.

## Contribution:

Feel free to fork this repo and contribute any way you see fit. Otherwise, I can be reached by the methods listed in the 'Contact' section

## Tests:

COMING SOON

## License:

[MIT](https://opensource.org/licenses/MIT/)

# Contact:

## GitHub:

[Krenbot](https://github.com/Krenbot)

## Email:

[email protected]