This CLI JavaScript app guides users through creating a professional README.md file for a GitHub repo. The user is prompted on the console input a Project Title, Project Description, Installation Instructions, Usage Instructions, License Information, Contribution Guidelines, Test, and where to direct further Questions. Users are guided through each step in the process with helpful hints and links. If the users doesn't need a particular section, leaving the input blank will remove that field from the finished markdown file.
Clone the repo locally, and in the console run 'npm install' within the top level of that folder
Within the project folder run node index.js
Checkout this video (hosted on Google Drive) of me making this README!
This repo is covered by the Unlicense license
Feel free to clone/fork and modify this repository.
No tests are provided for this repositiory
Find me on GitHub at: https://github.com/jodoedjr