Project Title

INSERT GRAPHIC HERE (include hyperlink in image)(optional)

Table of Contents (Optional)

If your README has a lot of info, section headers might be nice.

• Description
• Badges
• Installation
• Features
• Contributing
• Team
• FAQ
• Support
• License

Description

Subtitle or Short Description Goes Here

ideally one sentence

include terms/tags that can be searched

Badges

• build status
• issues (waffle.io maybe)
• devDependencies
• npm package
• coverage
• slack
• downloads
• gitter chat
• license
• etc.

• To easily create badges go to shields.io.

• For more on these wonderful badgers badges, refer to badgerbadgerbadger.

INSERT ANOTHER GRAPHIC HERE

• Most people will glance at your README, maybe star it, and leave
• Ergo, people should understand instantly what your project is about based on your repo

Tips

• HAVE WHITE SPACE
• MAKE IT PRETTY
• GIFS ARE REALLY COOL

GIF Tools

• Use Recordit to create quicks screencasts of your desktop and export them as GIFs.
• For terminal sessions, there's ttystudio which also supports exporting GIFs.

Recordit

ttystudio

---

Example (Optional)

// code away!

let generateProject = project => {
  let code = [];
  for (let js = 0; js < project.length; js++) {
    code.push(js);
  }
};

---

Installation

• All the code required to get started
• Images of what it should look like

A step by step series of examples that tell you how to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Clone

• Clone this repo to your local machine using https://github.com/VsIG-official/SOME-REPO

Setup

• If you want more syntax highlighting, format your code like this:

update and install this package first

$ brew update
$ brew install VsIG

now install npm and bower packages

$ npm install
$ bower install

• For all the possible languages that support syntax highlithing on GitHub (which is basically all of them), refer here.

---

Features

Usage (Optional)

Documentation (Optional)

Tests (Optional)

• Going into more detail on code and technologies used
• I utilized this nifty Markdown Cheatsheet for this sample README.

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

---

Contributing

To get started...

Step 1

• Option 1

  • 🍴 Fork this repo!

• Option 2

  • 👯 Clone this repo to your local machine using https://github.com/joanaz/HireDot2.git

Step 2

• HACK AWAY! 🔨🔨🔨

Step 3

• 🔃 Create a new pull request using https://github.com/joanaz/HireDot2/compare/.

---

Built With

• Dropwizard - The web framework used
• Maven - Dependency Management
• ROME - Used to generate RSS Feeds

---

Team

Or Contributors/People

VsIG	VsIG	VsIG
github.com/VsIG-official	github.com/VsIG-official	github.com/VsIG-official

• You can just grab their GitHub profile image URL
• You should probably resize their picture using ?s=200 at the end of the image URL.

---

FAQ

• How do I do specifically so and so?
  • No problem! Just do this.

---

Support

Reach out to me at one of the following places!

• Website at VsIG
• Insert more social links here.

---

Donations (Optional)

• You could include a Gratipay link as well.

---

Acknowledgments

• Hat tip to anyone whose code was used
• Inspiration
• etc

---

License

• MIT license
• Copyright 2020 © VsIG.