INSERT GRAPHIC HERE (include hyperlink in image)
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.
- For more on these wonderful
badgersbadges, refer tobadgerbadgerbadger
OR INSERT YOUR 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
Tools
- Use QuickCast, Recordit to create quicks screencasts of your desktop.
- For terminal sessions, there's asciinema
QuickCast
<iframe name='quickcast' src='http://quick.as/embed/r5krugrle' scrolling='no' frameborder='0' width='100%' allowfullscreen></iframe><script src='http://quick.as/embed/script/1.60'></script>asciinema
<script type="text/javascript" src="https://asciinema.org/a/3779.js" id="asciicast-3779" async></script>If you're
READMEhas a lot of info, section headers might be nice.
// code away!
generateProject: () => {
let project = "Deployed";
let code = [];
for (let js = 0; j < project.length; js++) {
code.push(js[i])
}
}- All the
coderequired to get started - Images of what it should look like
- Clone this repo to your local machine using
https://github.com/fvcproductions/SOMEREPO
- 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.
- Going into more detail on code and technologies used
- I utilized this nifty Markdown Cheatsheet for this sample
README.
To get started...
- Option 1
🍴 Fork this repo!
- Option 2
Clone this repo to your local machine using https://github.com/fvcproductions/SOMEREPO
And then follow our guidelines and make a pull request!
- How do I do specifically so and so?
- No problem! Just do this.
Reach out to me at one of the following places!
- Website at
fvcproductions.com - Twitter at
@fvcproductions - Insert more social links here.
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=200at the end of the image URL.
- You could include a Gratipay link as well.
- MIT license
](http://badges.mit-license.org)
- Copyright 2015 © FVCproductions

