leapjs/README.md

JavaScript client for the Leap Motion Controller

# LeapJS

Welcome to the Leap JavaScript framework. This is intended for use with the Leap (https://www.leapmotion.com/).

[![Build Status](https://travis-ci.org/leapmotion/leapjs.png)](https://travis-ci.org/leapmotion/leapjs)

For more information, please visit [http://js.leapmotion.com/](http://js.leapmotion.com/).

For examples, please see [http://js.leapmotion.com/examples](http://js.leapmotion.com/examples). There are also some
basic examples included in the `examples` directory.

For info about plugins, see [the wiki](http://github.com/leapmotion/leapjs/wiki/Plugins) and the [leapjs-plugins repo](http://github.com/leapmotion/leapjs-plugins).

## Compatibility

Version 0.3.0 or greater of leapjs requires version 1.0.9 or greater of the tracking software which is available at
[https://www.leapmotion.com/setup](https://www.leapmotion.com/setup) in order to have background support work properly.
Mixing and matching prior versions will result in inconsistent background/focus support.

## Contributing

Add your name, email, and github account to the CONTRIBUTORS.txt list, thereby agreeing to the terms and conditions of the Contributor License Agreement.

Open a Pull Request. If your information is not in the CONTRIBUTORS file, your pull request will not be reviewed.

## Protocol

Details about the protocol used to communicate with `leapd` are detailed here
[PROTOCOL.md](https://github.com/leapmotion/leapjs/blob/master/PROTOCOL.md).

##  Examples

Some examples have been included in the <code>examples/</code> directory. To run them do the following:

1. Run `npm install` *
2. Run `make serve`
3. Point your browser to [http://localhost:8080/examples](http://localhost:8080/examples)

Or in code:

1. Run `node examples/node.js`

[![githalytics.com alpha](https://cruel-carlota.pagodabox.com/f4522a98d0918ac69a49119ac3249bdb "githalytics.com")](http://githalytics.com/leapmotion/leapjs)

## *Installation problems with Leap.js

You may encounter a problem with an error message including `SELF_SIGNED_CERT_IN_CHAIN`. 
This is often a result of changes in OSX's security system; try reinstalling Node.js.

If that does not work, turn off SSL checking with the following instructions:

``` bash

npm config set strict-ssl=false
npm install leapjs -v0.4.1

````