Using node.js, the inquirer package and the starter code repository (found at https://github.com/coding-boot-camp/potential-enigma), we created a command line application that asks users questions and generates them a professionally styled README for their projects. This README was actually made using README2filth's generator! Give it a go and enjoy peace of mind knowing you have all your README bases covered.
To install necessary dependencies, run the following command:
npm i
To use my application, simply clone the repository into your directory of choice, open its 'develop' directory in your integrated terminal, make sure inquirer is installed and run 'node index.js' in your terminal. After answering all the questions, your README should appear in the README2filth directory, ready to upload to your repository.
This project is licensed under the MIT license.
Contribution guidelines would go here, but there are none for the README2filth repo.
To perform tests, run the following command:
npm test
If you have any questions about this project, you can contact me at acst52@gmail.com.
You can find more of my work at acst52.