README FILE GENERATOR

🚩 TABLE OF CONTENT

• Description
• Usage
• Technology used
• Installation
• Tests
• Credits
• Contributing
• Questions
• License

📖 DESCRIPTION

🎯 What is it about?

It is a command-line application that generates a professional README.md file based on user input, a time-saver tool for all developers.

🔍 Preview

The following image shows the web application's appearance and functionality:

💻 USAGE

This is a command-line application that runs with Node.js.

Walkthrough video of the application

💬 User story

As a developer, I want to use the README file generator to generate a README file for my project so that I can devote more time to working on my project.

🔌 TECHNOLOGY USED

-Javascript

-Npm

-Node.js

🚀 INSTALLATION

To use the app, you will need to have node.js installed then run npm install inquirer.

✅ TESTS

No tests available at the moment.

💬 CREDITS

Badges

• Shields.io
• License badge repository
• Simple Icons
• Simple Icons Slugs

Inquirer.js

• Documentation
• Examples

Input validation

• Regex101
• Email validation Regex
• Github username validation

README requirements

• Professional README guide
• Readme.so

Video

• Screenpresso - to record
• ClipChamp - to edit

Thank you

• Clobee for helping me with Regex
• Tudor Andrei for explaining the concept of async functions
• My teachers and classmates at Trilogy Skills Bootcamp

✨ CONTRIBUTING

All contributions are welcome. Contribution guidelines will be available soon.

❔ QUESTIONS

• If you have any questions, please click here to send me an email.
• You can also visit my Github profile @senseilein.

📃 LICENSE

This application is covered under MIT License.