Skip to content

This app creates Readme files for GitHub repos using JavaScript, Node.js, and an NPM package named inquirer.

License

Notifications You must be signed in to change notification settings

dyoder838/README-generator

Repository files navigation

Readme Generator

GitHub License Contributor Covenant

Description

This app creates Readme files for GitHub repos using JavaScript, Node.js, and an NPM package named inquirer.

Table of Contents

Installation

This app is installed in the command terminal Install Contributor Covenant by executing the following commands in command terminal: npm install -g covgen; covgen "<your_email_address>" Then run NPM install – this will install the packages in the package.json file

Usage

To use the app. Simply type node index.js in the command line. You will be asked to type in a series of responses. After the responses are complete, the app will automatically write a generatedReadme.md file for you and place it in your current folder. Copy and paste, or rename the file to whatever you chose. Video Tutorial screenshot

Credits

Collaborators

No collaborators at this time

Third Party Assets

No third-party assets at this time

Tutorials

Thank you to Sara Munir for sharing her work and giving me a boost when I was stuck.

License

This project is using the standard MIT License. See LICENSE for Terms and Conditions.

Badges

GitHub language count GitHub repo size

Contributing

Contributor Covenant

Tests

no tests written at this time

About

This app creates Readme files for GitHub repos using JavaScript, Node.js, and an NPM package named inquirer.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published