erikplachta / readme-builder-with-nodejs

Using Node.js to build a professional README.md dynamically based on user input. Lets you quickly and easily generate a README file by using a node via the command-line. This allows the developers to quickly generated uniform READMEs for all projects.

A Professional README Generator with Node.js

Description

Using Node.js to build a professional README.md dynamically based on user input.

Lets you quickly and easily generate a README file by using a node via the command-line. This allows the developers to quickly generated uniform READMEs for all projects.

Index

• Useage
  • Requirements
  • Installation
  • Using The App
  • Starting the App
  • Viewing Results
  • Repo Stats
  • Video of Full Process
• Contributors
• Questions?

Usage

Below I've broken down app requirements, how to install, start, use, and then view the results of this app.

Requirements

• Node.js
• Inquierer.js

Installation

This app is designed to be ran locally. That means you'll need to download the repo.

Starting The App

Using the App

Viewing Results

Video of Full Process

• For your convience, here is a video/gif of the full process

Repo Stats

Contributors

Erik Plachta

• Reviewed concept, and re-built from the ground up.

Xandromus

• Built the concept of the project.

Questions?

Feel free to contact me on my twitter @ErikPlachta