You can quickly and easily create a README file by using a command-line application to generate one. This allows you, the project creator, to devote more time to working on the project.

• Installation
• Usage
• Features
• Contribute
• Credits
• License

Once you clone this repository, you will need to open the terminal in the folder that contains your index.js file. First run 'npm install' to install node modules. Then run 'node index' to see the app in action.

npm install
node index

Once your node modules are installed, simply type 'node index' into the terminal and proceed through the questions. The generated Readme file will be in the Results FOLDER. There is help text that further assist you in building a robust and informative README.

Some enhanced features include:

• This generator only creates content for the sections that have inputs;
• The Table of Contents items are dynamically created based on whether content exists;
• There is help text throughout, so the user can expand on their readme content.

View this app in motion:

• video of inquirer prompts
• video of README file in VS code
• video of README file on Github

Screenshots of app:

• img of inquirer prompts

• img of README file in VS code

• img of README file on Github

• Github Repo

This project is created with the following technologies:

• Node.js
• Inquirer.js

The code for this project was researched extensively. Here are a few of the tutorials I found helpful:

• The “+=” operator

  Just like the “+” operator, the “+=” operator can be used for concatenation as well. If used with numbers, it’ll add the numbers and assign it to the variable at the left-hand side of the operator. But when used with one or more strings, it’ll automatically transform into yet another string concatenation operator and concatenate the two operands, even if one of them is a number.

• if(x==2) dosomething();

  This is from stackoverflow: Omitting the second expression when using the if-else shorthand. user: ajax333221

• Template Literals and String interpolation

  String interpolation is a process where you can pass a valid JavaScript expression such as a variable into a template literal. The expression inside ${} is evaluated, and the result of the evaluation is embedded into the string.

• Additional examples on Template Literals and expression interpolation

  The syntax for expression interpolation is ${}. Anything we place between the curly brackets will be executed as code. In here we can pass variables, functions, or other logic that will be evaluated and it’s final value displayed.

Please feel free to fork this project and create your own branch. Any suggestions for improvement are welcomed.

This project is licensed under the MIT License

Contact me if you have any questions about this project:

• Send me an email

You can find my projects on Github:

• Find me on Github