README-generator

Description

Your GitHub profile is an extremely important aspect of your public identity as a developer. A well-crafted one allows you to show off your work to other developers as well as potential employers. An important component of your GitHub profile—and one that many new developers often overlook—is the README.md file.

This command line README generator makes it easy to create and fill out a professional README file, quickly and with all the right components!

Table of Contents

• Features & Technologies
• Installation
• Usage Demo
• Contributing
• License
• Got questions?

Features & Technologies ✨

• Top language and license badges
• Table of Contents for ease of use

Technology	Description	Link
Node.js	JavaScript runtime built on Chrome's V8 JavaScript engine	https://nodejs.org/en/
Inquirer.js	A collection of common interactive command line user interfaces	https://www.npmjs.com/package/inquirer

Installation 🛠️

1. Download a copy of this repository
2. Make sure you have Node.js and npm installed
   • Install necessary npm packages via npm install
3. Navigate to the file location of the downloaded repository using the command line
4. Run node index.js
5. After completion, a sample-README.md file should appear within the directory

Usage Demo

A sample README file can be found in the root directory

sample README.md

Contributing

Feel free to create a new issue or alternatively, make a pull request!

License

MIT

Got questions? 🤔

Contact me @ [email protected]