kpegeder / readme-generator

Helps you create a professional README

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Readme Generator

License Badge Code Badge

Description

The index.js file will prompt the user to answer a series of questions. Based on the answer, a quality and professional README is generated with a title of the project and other necessary sections. The sections with inputed information will be description, installations, usage, contribution and test instructions. You'll be asked which type of license to use and a badge. At the end, there will be a question section with an email and GitHub profile link.

Table of Contents

Installation

To install necessary dependencies, run the following command:

npm i

Usage

Instructions to use the program are shown below

  1. Run node index.js
  2. Answer all of the questions

Demo

To watch a video of the demo

Test

To run tests, run the following command:

npm test

Contributing

Kalen Pegeder

License

Licensed under the MIT license.

Questions

If you have any additional questions about the applictaion, you can contact through email. You can see more of my work on GitHub.

About

Helps you create a professional README


Languages

Language:JavaScript 100.0%