/README-writher

A command-line app to generate README markdown files based on user inputs.

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

README Writher

License: GPL v3

Description

A command-line app to generate README files based on user input and help them dominate the realm by defeating the README wraithes. Writhe, wraithes, writhe!

Table of Contents

Installation

Install an Inquirer NPM package (npm install inquirer).

Usage

Run a "node index.js" command and then answer all of the questions asked. README will be generated!

A screencast demonstrating the use of the app

License - GNU GPL v3

GNU GENERAL PUBLIC LICENSE

Version 3, 29 June 2007

Copyright © 2007 Free Software Foundation, Inc.

https://fsf.org/

Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

More...

Contributing

Knock yourself out!

Tests

That's what this README is based on - one of the tests. So, if you are running this in a directory with an existing README.md file - beware that it is not overwritten.

Questions

With further questions, please contact me:

Link to the finished product

README Writher GitHub repository

Screenshots:

First run-through:

README generated

Second run-through:

README generated