Quickstart

From NPM

Griddle is in the npm repository as griddle-react. Simply install React and Griddle from npm:

npm install react --save
npm install griddle-react --save

From there, require React and Griddle in your modules and you should be all set!

var React = require('react');
var Griddle = require('griddle-react');

Please take a look at a basic gulp example or a webpack example for more information.

---

From Source

At the most basic level, using Griddle is as simple as wiring up an array of JSON objects as a property to the component. First off, include React and Griddle before your React Code.

<script src="//fb.me/react-0.13.2.js"></script>
<script src="//fb.me/JSXTransformer-0.13.2.js"></script>
<script type="text/javascript" src="scripts/griddle.js"></script>

---

Define an array of JSON objects -- for our examples we have something that resembles the following:

var fakeData =  [
{
  "January": 35,
  "February": 20,
  "March": 27,
  "April": 32,
  "May": 23,
  "June": 42
},
...
];

From there, render a Griddle component through React.renderComponent or in the Render method of another component.

<Griddle results={fakeData}/>

While this example is pretty simple, there are a lot more advanced things you can do with Griddle with out much code. Check out the documentation and examples to see more of what can be accomplished.