geckogrpautomation/readmecli

#CLI Readme Generator
##readme.md

Project Title - CLI Readme Generator

Project Description

A commanmd line interface tool that allows the user to create a professional readme in a short time.
Link to the repo.

Bug Report Feature Request

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Usage Video
3. Contributing
4. License
5. Contact/Questions

About The Project.

A commanmd line interface tool that allows the user to create a professional readme in a short time.

Built With.

• HTML
• CSS
• JS
• Markup
• Shields.IO
• Inquirer

Getting Started.

To get the code and download the dependancies to succesfully execute your own version see below....

Prerequisite

• inquirer

Installation

1. Clone the repo. Open Git Bash or similar into your required directory.

   git clone githubclone.com

2. Install NPM packages

* npm install  

The repo should have a package.JSON and a package-lock.JSON file which lists all the dependancies. Hence only npm install is required.

Usage video

See below link for a link on how to use our code.

https://drive.google.com/file/d/1a1vzR832Q0UC6sBqhhzfyl_FnzupMr_1/view

Contributing

Thanks to all the contributors on this project. You are legends!

• Lachlan Cameron

In order to contribute. Please follow the below:

1. Fork our Project.
2. Start creating your extra features. (git checkout -b feature/AmazingFeature)
3. Commit your changes. (git commit -m 'Add some AmazingFeature')
4. Push to the branch you have checked out. (git push origin feature/AmazingFeature)
5. Create a pull request and add an admin to verify the code.

License

Distributed under the following license:

Contact / Questions.

Github - geckogrpautomation --- Email - [email protected]

Project Link: - github.com

readmecli's Issues

License issue badge bot working like other badges

Badges not reading from shields IO