Skip to content

To quickly and easily create a README file that uses a command-line application.

License

Notifications You must be signed in to change notification settings

Kimberly-Rodriguez/README-Generator

Repository files navigation

README-Generator

Table of Contents

Description

To quickly and easily create a README file that uses a command-line application. Thus allowing the project creator to allocate more time to programming the application itself.

Instalation

  • Clone the repo (please reference the links below).
git@github.com:Kimberly-Rodriguez/README-Generator.git
  • Install NPM packages
npm install npm@latest -g

For additional details on installation and deployment, please click here. The GitHub link is here.

This command-line application accepts user input and creates a professional README.md with the title of my project and sections entitled Description, Table of Contents, Installation, Usage, License, Contributing, Tests, and Questions.

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

"screen shot 1 of applicating showing the end product"

video link

Usage

To quickly create a professional README for a new project.

Tools

This project was built using Node.js, the Inquirer package and the Professional README Guide.

Contact

If you have any questions about my work OR wish to collaborate in the future please contact me via email: krodriguez.ucla@gmail.com OR feel free to connect via GitHub: Kimberly-Rodriguez.

License

Licensed under the MIT License.

Acknowledgements

UCLA Extension Coding Bootcamp

About

To quickly and easily create a README file that uses a command-line application.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published