Project Title

Motivation

What makes your project unique? Why is important?

Status

it's still alive? wercker status Coverage Status

Screenshots / GIFs

fancy captures here!

fancy capture 1 fancy capture 2 fancy capture 3

Features

  • Feature 1
  • Feature 2
  • Feature 3

Getting Started

Prerequisites

shell instruction 1
shell instruction 2
...

Installing and running

shell instruction 3
shell instruction 4
...

Usage

const myProject = require('project');
myProject.crash();

Running the tests

run tests
...

Test enviroments

url to test
url to stage
...

Contributing

  • Requirements for pull requests?
  • Code standards?
  • Coverage?

Release process

  • Gitflow?
  • Gitflow without develop?

Useful data

  • New relic links
  • Metrics
  • Common issues during guards
  • Related projects

Credits - Where to get help!

See also the list of contributors who participated in this project.