scarlet-init/lib/templates/gulp-mocha/README.md

Scarlet-init is a scaffolding tool used to automate Scarlet plugin creation.

{name}
======================

> {description}

##Install

  `npm install {name}`

## Getting Started
This plugin requires Scarlet `{scarletVersion}`

If you haven't used [Scarlet](https://github.com/scarletjs/scarlet) before, be sure to check out the [Documentation](https://github.com/scarletjs/scarlet).  To use this plugin perform the following:

Install scarlet
```shell
npm install scarlet --save
```

Install plugin
```shell
npm install {name} --save
```

Once the plugin has been installed, you can use it in your application as follows:

```js
//load scarlet
var Scarlet = require('scarlet');

//Initialize scarlet with the plugin
var scarlet = new Scarlet('{name}');
var {instanceName} = scarlet.plugins.{pluginName};
```