Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Markdown Generator

MIT License Badge

Description

A command-line application that generates a README.md from user prompts. Using Inquirer to collect project details (title, description, installation, usage, tests, contributing, and license), then outputs a formatted Markdown file with a table of contents and an optional license badge/link based on the selected license.

Table of Contents

Installation

"npm install" is all you need if you have the package.json file.

Usage

Run "node index.js" inside the terminal and answer the provided prompts. You will then find the README.md file inside your project folder.

Credits

Implemented by @bearsanity

LinkedIn: https://www.linkedin.com/in/james-sweeney-304905206/

License

This project is licensed under the terms of the MIT License. Try here, for more information on the license.

Tests

node index.js to run the program is the only test currently provided.

Questions

If you have any questions - contact me through any of these:

Github: @bearsanity

Email: jsweeney96@hotmail.com

About

Generate professional ReadMes

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages