resonantdevotion/readmegenerator

"Creating a command-line application that dynamically generates a professional README.md file from a user's input using the Inquirer package. "

Title

README generator

Description

Using node.js, the inquirer package and es6, we had to create an application that would easily generate a unique README file with the users input, guided by prompts. This was made to make the sometimes tedious process of creating a README, easy. In the process I learnt about node.js, arrow functions, licence badges and es6.

Contents

- Installation

- Usage

- Licence

- Contributions

- Tests

- Credits

Installation

The steps required to install this application are: Install VS code

Usage

To use the app follow these instructions: To use just type in 'node index' into your integrated terminal and follow the question prompts. It may help to have some ideas in mind before you start!

Licence

This application is covered by the MIT licence. As shown in the badge displayed in the title.

Contributions

If you would like to contribute please contact me through my email: If you would like to contribute, please contact me through the bootcamp slack channel or my github below

Tests

Please follow the following instructions to test the application: To test, please follow the usage instructions!

Credits

I would like to give credits to: Always a great thanks to my bootcamp team mates and the instructors. Ben and Sansi gave advice and helped me debug at times. Licence badge was sourced from: https://gist.github.com/lukas-h/2a5d00690736b4c3a7ba

Questions

If you have any additional questions, please contact me through my email: [email protected] or go to my github: https://github.com/resonantdevotion

readmegenerator's Issues

Images