This README Generator is a command-line application that allows for the quick and easy generation of a project README file. This will allow a project creator to spend more time working on finishing the project and less time creating a good README. The content of the generated README file is collected from User input using the Inquirer package.
To create a functional application that generates a professional README.md from user input. The Good README guide was reviewed during this project to ensure that the file generated was appropriate and professional. The application will be invoked with the following command:
node index.js
AS A developer I WANT a README generator SO THAT I can quickly create a professional README for a new project
GIVEN a command-line application that accepts user input
WHEN I am prompted for information about my application repository
THEN a quality, professional README.md is generated with the title of your project and sections entitled Description, Table of Contents, Installation, Usage, License, Contributing, Tests, and Questions
WHEN I enter my project title
THEN this is displayed as the title of the README
WHEN I enter a description, installation instructions, usage information, contribution guidelines, and test instructions
THEN this information is added to the sections of the README entitled Description, Installation, Usage, Contributing, and Tests
WHEN I choose a license for my application from a list of options
THEN a badge for that license is added hear the top of the README and a notice is added to the section of the README entitled License that explains which license the application is covered under
WHEN I enter my GitHub username
THEN this is added to the section of the README entitled Questions, with a link to my GitHub profile
WHEN I enter my email address
THEN this is added to the section of the README entitled Questions, with instructions on how to reach me with additional questions
WHEN I click on the links in the Table of Contents
THEN I am taken to the corresponding section of the READMEThis responsive application has one main Javascript file. A sample README file, generated by this application is also included.
| File | Relative Path |
|---|---|
| index.js | index.js |
| package.json | package.json |
| package-lock.json | package-lock.json |
| README.md | Sample-README/README.md |
- Visual Studio Code - The editor of choice
- GitHub
- Inquirer Package
- GPLv3.0: General Public License v 3.0 is selected for the sample README file, although this is merely a simulation of the application.
Please view a walkthrough video hosted on Google Drive demonstrating how a user would invoke the application from the command line, enter responses to all of the inquirer prompts in the application, and finally generate a README file.
- SARAH RONALD - Contact information: sareronald@hotmail.com