README Generator

Simple, attractive markdown for your repos.

Table of Contents

• Description
• Installation
• Usage
• License
• Contributors
• Questions

 

Description

This application prompts the user through the creation of an easy, attractive README for their repos! It was created with Node.js using Inquirer. The goal is to quickly create a nice markdown file for your repos, so you can get back to coding.

 

Installation

Clone this repo and run it locally to start making your README.

 

Usage

Open your repo folder in Terminal or CLI, and enter:

npm install
node index

This will install the dependencies then start the application. Think about your markdown syntax when answering the prompts if you would like to include any special formatting, text effects or links in your description or instructions.

// Include code examples, if you like:
const readMe = () => alert(`Read the README!`);

The script for this repo will take care of the rest of the content structure.

 

---

 

License

Open source. Enjoy.

 

Contributors

Just me for now.

 

Questions?

• David Metcalf
• GitHub: gloriousLoaf
• hello@metcalf.dev

 

See a quick demo on YouTube: (https://youtu.be/OsmWsAmRb60)

---

This markdown was created with Readme Generator