Repository Title Goes Here
Subtitle or Short Description Goes Here
ideally one sentence
include terms/tags that can be searched
Badges will go here
- build status
- issues (waffle.io maybe)
- devDependencies
- npm package
- coverage
- slack
- downloads
- gitter chat
- license
- etc.
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
GIF
s. - For terminal sessions, there's ttystudio which also supports exporting
GIF
s.
Table of Contents (Optional)
If your
README
has a lot of info, section headers might be nice.
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
Clone
- Clone this repo to your local machine using
https://github.com/fvcproductions/SOMEREPO
Setup
- If you want more syntax highlighting, format your code like this:
update and install this package first
$ brew update
$ brew install fvcproductions
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
.
Contributing
To get started...
Step 1
-
Option 1
🍴 Fork this repo!
-
Option 2
👯 Clone this repo to your local machine usinghttps://github.com/joanaz/HireDot2.git
Step 2
- HACK AWAY!
🔨 🔨 🔨
Step 3
🔃 Create a new pull request usinghttps://github.com/joanaz/HireDot2/compare/
.
Team
Or Contributors/People
FVCproductions | FVCproductions | FVCproductions |
---|---|---|
github.com/fvcproductions |
github.com/fvcproductions |
github.com/fvcproductions |
- 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
fvcproductions.com
- Twitter at
@fvcproductions
- Insert more social links here.
Donations (Optional)
- You could include a Gratipay link as well.
License
- MIT license
- Copyright 2015 © FVCproductions.