plumes/README.md

Flying-fast Metro future vision components

# Plumes

[![Join the chat at https://gitter.im/CodeCorico/plumes](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/CodeCorico/plumes?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Issue Stats](http://issuestats.com/github/codecorico/plumes/badge/issue)](http://issuestats.com/github/codecorico/plumes)
[![Issue Stats](http://issuestats.com/github/codecorico/plumes/badge/pr)](http://issuestats.com/github/codecorico/plumes)

Flying-fast Metro future vision components

[![Microsoft: Productivity Future Vision](http://img.youtube.com/vi/w-tFdreZB94/0.jpg)](http://www.youtube.com/watch?v=w-tFdreZB94)

## Installation

Include the module in your project with :
```
npm install --save plumes
```

## How to use it

### Compile template files

You can compile and move your Less, JavaScript and HTML files to your ```/public``` folder with Plumes.

To start the gulp watcher, include this code in your *gulpfile.js* then start ```gulp```:

```javascript
var Plumes = require('plumes');

new Plumes({
  paths: {
    features: './features',
    public: './public'
  }
});
```

### Use the components

Plumes contains many Ractive components and CSS layouts. To use it you have to include [Ractive](http://ractivejs.org), [Ractive Require](https://github.com/XavierBoubert/ractive-require) and [jQuery](http://jquery.com):

```html
<script src="http://cdn.ractivejs.org/latest/ractive.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/ractive-require/0.5.4/ractive-require.min.js"></script>
<script src="https://code.jquery.com/jquery-2.1.3.min.js"></script>
```

Each component is compiled and ready to use in the ```/public``` folder.

## Example

You can try all of the components with the [examples](examples/).