rabbit-hole/README.md

A volumetric terrain engine for three.js.

# Rabbit Hole
[![Build status](https://travis-ci.org/vanruesc/rabbit-hole.svg?branch=master)](https://travis-ci.org/vanruesc/rabbit-hole) 
[![npm version](https://badge.fury.io/js/rabbit-hole.svg)](http://badge.fury.io/js/rabbit-hole) 
[![Dependencies](https://david-dm.org/vanruesc/rabbit-hole.svg?branch=master)](https://david-dm.org/vanruesc/rabbit-hole)

A volumetric terrain engine for three.js.


## Preface

This module uses modern ECMAScript features and requires one of the following browsers:
 - Chrome ≥ 42
 - Firefox ≥ 45
 - IE Edge ≥ 13

[Semantic versioning](http://semver.org/) is used in this module to indicate whether an update 
introduces breaking changes. However, backwards-compatibility regarding ECMAScript versions is 
entirely neglected in favor of cleaner code and development convenience.


## Installation

```sh
$ npm install rabbit-hole
``` 


## Usage

```javascript
// WIP
```



## Documentation
[API](http://vanruesc.github.io/rabbit-hole/docs)


## Contributing
Maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.


## License
[Zlib](https://github.com/vanruesc/rabbit-hole/blob/master/LICENSE)