/readme-robot

A readme generator

Primary LanguageJavaScript

ReadMe Robot

Description

A readme node.js generation application, aiming to make the creation of new repos with quality readme content easier.

License

Table of Contents

If your README is long, add a table of contents to make it easy for users to find what they need.

Installation

npm install

Usage

Video Demo https://drive.google.com/file/d/1ft8q0UmVzbnZDOxsfxlXwPHIMEfobJwF/view

node index.js

see sample_readme.md for example output.

Credits and Questions

Please reach out by raising an issue if you have questions or suggestions. dustin.davisson@gmail.com https://github.com/Spikeophant

License

This application is covered by BSD-3-Clause

How to Contribute

Contributions gladly accepted, please open an MR!

Tests

npm run test