A command line application that dynamically generates a professional README.md file from a user's input using Inquirer npm.
Repo Link
NOTE: Since this application runs in the command line, it cannot be deployed on GitHub. Please see the Demo section for an overview of its functionality and the Getting Started section for more information regarding installation, usage, contribution guidelines, tests and where to go for questions.
- About The Project
- Project Links
- Demo
- Getting Started
- Installation
- Usage
- Tests
- Contribution Guidelines
- Questions
- Project Status
- License
When creating an open source project on GitHub, it’s important to have a high quality README for the app. This should include what the app is for, how to use the app, how to install it, how to report issues, and how to make contributions. Contributions are particularly important as they increase the likelihood that other developers will contribute to the success of the project.
The project scope was to create a command line application that dynamically generates a professional README.md file from a user's input using the Inquirer npm package. By quickly and easily creating a README file (by using a command line application to generate one) a project creator has more time to devote to working on their project.
The application will be invoked by using the following in the command line:
node index.js
Because this application cannot be deployed on GitHub, a walkthrough video demonstrates its functionality below.
The following is a brief overview of the application in operation and rendering of generated README.
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 high-quality, professional README.md is generated with the title of my 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 near 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 README
- JavaScript
- Node.js
- Inquirer npm
git clone - https://github.com/onomatopoetica/Good-README-Generator.git
The project is a command-line application using Inquirer npm which dynamically generates a README.md file from user's input.
See demo video above for more information on how it works.
The application will be invoked by using the following in the command line: node index.js
When contributing to this repository, please first discuss the change you wish to make via issue or email with the project team. See contact details below.