readme-generator
readme-generator
does what it says on the tin! It is a program that can be run to generate a high quality, professional README.md file via command line!
Table of Contents
Installation
To install, simply clone this repository using git and install the necessary dependencies via npm.
Usage
To use, run the index.js
file with node.js while your current working directory set to the location you wish for the README.md file to be output. The program will prompt you with several categories for information you can include in the README.md file.
Contibution
Currently not accepting contributions, but feel free to star the project!
Testing
The project tests are private and not available to the public.
Questions
For questions or other inquiries, feel free to reach out to me via either GitHub or send an email to kaidangustave@yahoo.com