This is a command-line application that creates professionally structured README.md files. The user must input a project title and description, as well as their GitHub username and email to be added to the 'Questions' section of the README file. Users also have the choice of including any of the following sections:
- Table of Contents
- Installation
- Usage
- License
- Contributing
- Tests
The application takes a user's responses to the command-line prompts to use as content for the README file.
The main motivation for this project was to create an application that facilitates the documentation aspect of projects for developers, which can be tedious and repetitive.
- Clone this repository to your local computer
- Open the command line and navigate to the cloned repository (the 'readme-generator' directory)
- Install dependencies (npm inquirer package) by entering the command: npm install
Click here to view a video walkthrough of the README generator functionality.
- JavaScript
- Command-line interface
- Node.js
- npm inquirer package
- Screencastify
This application is covered under the ISC license. For more information, click here.
My GitHub Profile: jkaho
If you have any further questions, please email me at j.h_7@yahoo.com.