sammcowen / readmeWizard

πŸͺ„πŸ“„ Tired of writing readmes? Not anymore ! Use readmeWizard , an application built with Node.js and inquirer npm . Answer the prompts to generate a professional readme.MD in minutes!

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

readme Wizard

Table of Contents

-Description

-Demo

-Installation

-Usage

-Questions

Description

A command line application that allows users to enter their project's information and instantly generate a professional readme.

Demo

Here is a short demo of my readmeWizard !

Untitled_ Feb 18, 2022 10_29 PM

Here is a link to the FULL DEMO as well. ReadmeWIZARD Demo

Installation

Follow these steps to properly install this application: Run npm install for inquirer, fs and utils.

Usage

Instructions for use: Run the command node index.js in your terminal. This will prompt the questions from inquirer. Your input/answers to the questions will generate a professional readme for your project.Your answers will be used in the fs.write package, written in markdown format and will automatically generate a readme.md file once all required questions have been answered.

Questions

Any questions please reach out to me at my GitHub

About

πŸͺ„πŸ“„ Tired of writing readmes? Not anymore ! Use readmeWizard , an application built with Node.js and inquirer npm . Answer the prompts to generate a professional readme.MD in minutes!


Languages

Language:JavaScript 100.0%