This is a command-line application that dynamically generates a README.md file from a user's input. This is a Node.js based application and it's run with the following command:
node index.js
The user will be prompted for their GitHub username, which makes a call to GitHub's API to retrieve their email and profile image. They will then be prompted with questions about their project.
The README will be populated with the following:
- At least one badge
- Project title
- Description
- Table of Contents
- Installation
- Usage
- License
- Contributing
- Tests
- Questions
- User GitHub profile picture
- User GitHub email
To install project dependencies run:
npm i
This project the uses axios and inquirer package.
To run tests run:
npm run test
Feel free to clone or fork this repo.
If you want to contribute to this project you can submit a pull request as well.
Have any questions? Want to collaborate on a project? Shoot me an email