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

Node CLI Tool to dynamically generate READMEs. Yeah...it IS cool. I know
https://github.com/iatenine/readme-generator

cli node nodejs readme-generator

Last synced: 13 days ago
JSON representation

Node CLI Tool to dynamically generate READMEs. Yeah...it IS cool. I know

• Host: GitHub
• URL: https://github.com/iatenine/readme-generator
• Owner: iatenine
• License: mit
• Created: 2021-08-19T04:20:37.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-09-14T18:30:09.000Z (over 3 years ago)
• Last Synced: 2024-11-05T15:42:57.827Z (2 months ago)
• Topics: cli, node, nodejs, readme-generator
• Language: JavaScript
• Homepage:
• Size: 29.3 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# README Generator

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

# Table of Contents

[Description](#description)  

[Installation](#installation)  

[Usage](#usage)  

[Contributing](#contributing)  

[Tests](#tests)  

[Questions](#questions)  

[License](#license)

# Description

This project provides a CLI application using Node JS to generate professional  

grade README documents based on a user's input based on a series of prompts

# Installation

After cloning into the repo, simply run:

`npm install`

or

`yarn`

to install

# Usage

In a terminal, navigate to this program and run:

`npm run start`

or

`yarn start`

to be prompted for a series of questions regarding your project  

Once done, a README will be generated in the output directory

[Video Walkthrough](https://drive.google.com/file/d/1gwUp_OVWRSARaUFnHAGXVzXjR3MKFxN0/view?usp=sharing)

Note: If a README already exists in output, it will be overwritten

# Contributing

To contribute to this project:

- Find or open an issue related to a bug or desired feature

- Create a fork of the repo

- Make changes within the fork to address the issue

- Create a PR if you feel improvements have been made over the current iteration

# Tests

(None)

# Questions

[Maintainer](https://github.com/iatenine)  

For further questions, direct emails [here](mailto:[email protected])

# License

This project is covered under [The MIT License](https://opensource.org/licenses/MIT)