# JSDoc React

A [JSDoc](http://usejsdoc.org) template built with
[React](http://facebook.github.io/react/) and
[Bootstrap](http://getbootstrap.com).

## Examples

* [FKit API](http://nullobject.github.io/fkit/api.html)

## Install

Install the npm package:

```sh
> npm install jsdoc-react
```

Then run JSDoc with the template:

```sh
> jsdoc -t jsdoc-react ...
```

# License

JSDoc React is licensed under the MIT license. See the
[LICENSE](https://github.com/nullobject/fkit/blob/master/LICENSE.md) file for
more details.

# JSDoc React

A [JSDoc](http://usejsdoc.org) template built with
[React](http://facebook.github.io/react/) and
[Bootstrap](http://getbootstrap.com).

## Examples

* [FKit API](http://nullobject.github.io/fkit/api.html)

## Install

Install the npm package:

```sh
> npm install jsdoc-react
```

Then run JSDoc with the template:

```sh
> jsdoc -t jsdoc-react ...
```

## Contribute

### Build

Build the library:

```sh
> make production
```

### Test

Run the tests:

```sh
> make test
```

### Release

Ship a new release x.y.z:

```sh
> make release version=x.y.z
```

# License

JSDoc React is licensed under the MIT license. See the
[LICENSE](https://github.com/nullobject/jsdoc-react/blob/master/LICENSE.md)
file for more details.

Add contribute section to readme.
Add contribute section to readme.
