I created the README Generator to quickly construct a professional README file for any new project. By utilizing the Inquirer package, I was able to create a series of prompts to collect the necessary user input to write a professional and detailed README file consisting of the following sections: Title of Project, Description, Table of Contents, Installation, Usage, License, Contributing, Tests, and Questions.
To install necessary dependencies, please run the following command:
npm install
You will need to utilize the Inquirer package for this application. Be sure to answer all of the questions to generate a complete, professional README. Please click here for a demo.
This project is covered under the Apache 2.0 license. Visit the following link for more information on this license: Apache 2.0
To test, please run the following command:
npm test
For any questions about the project, please contact me by either of the following links:
- Email - jordan.dubose1@gmail.com
or visit my GitHub profile:
- GitHub - jordandub1