Skip to content

This is a command-line application that dynamically generates a professional README.md file from a user's input using the Inquirer package.

Notifications You must be signed in to change notification settings

LeenaCruz/ReadMe-Generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Professional README Generator

Static Badge

Description

This is a README.md generator that works in the command line using node.js and inquirer prompt.

User Story

AS A developer I WANT a README generator SO THAT I can quickly create a professional README for a new project.

Table of Contents

Installation

Download index.js >> open terminal or integrated terminal >> run node index.js >> answer prompts, you’re good to go!

Usage

You can generate professional looking README files with this README generator.

License

Mozilla Public License 2.0

Mock-Up

A video shows how to generate a README.md file using command line and node.js

Deployed Application

URL

Contributing

How to contribute to this project:

You can contribute to this repo creating a pull request.

Test

Test writing different inputs or create a test case.

Questions

Write any questions to: [email protected]

My GitHub: LeenaCruz

Future Features

Validate email, Format step by step installation.

Credits

Validate Empy Input | Badge Maker | Markdown Syntax | Replace empty strings

About

This is a command-line application that dynamically generates a professional README.md file from a user's input using the Inquirer package.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published