react-game-of-life/README.md

React game of life component.

# react-game-of-life
A React Component depicting the Conway's Game of Life.

This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app).

[Demo](https://lamdav.github.io/react-game-of-life/)

# Note:
This update has removed all `requirejs` in favor of es6 styled imports. If `requirejs` is required for your project, install 1.1.3.

# Install:
`npm install react-game-of-life`

# Test:
Clone the repo and run the command `npm start`.
This will run the dev-server and showcase a small component of the LifeManager.

# How to use:
```javascript
import React, {Component} from "react";
import ReactDOM from "react-dom";
import LifeManager from "react-game-of-life";

ReactDOM.render(<LifeManager />, document.findElementById("game"));
```

# Props:
| prop              | description                                         | default | type   |
|:-----------------:|:---------------------------------------------------:|:-------:|:------:|
| width             | defines the width of the board                      | 20      | number |
| height            | defines the height of the board                     | 20      | number |
| fps               | defines the number of frames to refesh every second | 60      | number |
| lineColor         | defines the color of the cell's outline             | cyan    | string |
| cellActiveColor   | defines the cell's alive status color               | gray    | string |
| cellInActiveColor | defines the cell's inactive status color            | black   | string |