maxlemieux / readme-generator

A README file generator for GitHub repositories, built in node.js.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

readme-generator

A README file generator for GitHub repositories, built in node.js.

An interactive prompt will collect common data and build a readme in Markdown format, which can be used for your project.

The following data will be gathered:

  • Title
  • Description
  • Table of Contents
  • Installation
  • Usage
  • License
  • Contributing
  • Tests
  • Questions

Usage

Run with 'node index.js'.

Technologies

  • Node.js
  • Markdown
  • axios.js
  • inquirer.js
  • GitHub API
  • async/await

About

A README file generator for GitHub repositories, built in node.js.


Languages

Language:JavaScript 100.0%