macias-daniel / good-readme-generator

Generate a good read me with command line tool!

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Good Read Me Generator

AppDemo

License: None

Description

My project prompts the user with a couple of questions and based on those question the code will generate a readme.md file with readme best practices

Table Of Contents

Installation

Make sure to run npm install the first time you open this project.

  • This project utilizes axios and wont run without it

Usage

When creating a readme.md file input node index.js into terminal to begin prompting.

  • Your outputed readme will be placed in the output folder

License

This project is licensed under: None

Contributing

There really is no need for contributing, but if you feel the need to contribute, when you create a pull request make sure to attach multiple photos and a detailed description of features you want to add.

Questions

macias-daniel's avatar

Contact me at d.macias.apps@gmail.com if you have any questions about my project!

About

Generate a good read me with command line tool!


Languages

Language:JavaScript 100.0%