<commit_before># [GestureKit v1.1.0](http://gesturekit.com) [![Build Status](https://secure.travis-ci.org/RoamTouch/GestureKit.png)](http://travis-ci.org/RoamTouch/GestureKit) [![devDependency Status](https://david-dm.org/RoamTouch/GestureKit/dev-status.png)](https://david-dm.org/RoamTouch/GestureKit#info=devDependencies)

> A JavaScript library to recognize advanced gestures on web browsers.

Advantages:

- It's small and standalone.
- Dependency-free.
- Just 3 kb (min & gzip).
- Multi-device support.
- Easy-implementation.
- Made it with love.

## API

### Table of contents

- Methods
    - [.init()](#gesturekitinitoptions--uid)
    - [.enable()](#gesturekitenable)
    - [.disable()](#gesturekitdisable)
    - [.on()](#gesturekitonevent-listener-once)
    - [.once()](#gesturekitonceevent-listener)
    - [.off()](#gesturekitoffevent-listener)
    - [.getListeners()](#gesturekitgetlistenersevent)
    - [.emit()](##gesturekitemitevent-arg1-arg2-)

- Events
    - [load](#load)
    - [fail](#fail)
    - [enable](#enable)
    - [disable](#disable)
    - [recognize](#recognize)
    - [notrecognize](#noterecognize)<commit_msg>Update API docs.<commit_after># [GestureKit v1.1.0](http://gesturekit.com) [![Build Status](https://secure.travis-ci.org/RoamTouch/GestureKit.png)](http://travis-ci.org/RoamTouch/GestureKit) [![devDependency Status](https://david-dm.org/RoamTouch/GestureKit/dev-status.png)](https://david-dm.org/RoamTouch/GestureKit#info=devDependencies)

> A JavaScript library to recognize advanced gestures on web browsers.

Advantages:

- It's small and standalone.
- Dependency-free.
- Just 3 kb (min & gzip).
- Multi-device support.
- Easy-implementation.
- Made it with love.

## Compatibility
- iOS
 - iPhone/iPod iOS 6
 - iPad/iPhone iOS 7
- Android
 - Default browser
 - Chrome
 - Firefox

##Usage
### Add gesturekit.js into your HTML file.
You should {download} the library or use our link and reference the JavaScript file using a `<script>` tag somewhere on your HTML pages.
```html
<script src="http://libs.gesturekit.com/gesturekit.min.js"></script>
```

### Define your gesture listeners.
Once added the library you can create your listeners with the same name you have defined the gesture with `GK_` prefix.
```js
gesturekit.on('GK_NAME', function (event) {
    // Some code here!
});
```

### Initialize gesturekit.
Initializes the gesturekit library using the .init() method passing your `UID` as parameter.
```js
gesturekit.init({
    'uid': 'xxxx-xxxx-xxxx'
});
```

## API

### Table of contents

- [Methods](#methods)
    - [.init()](#gesturekitinitoptions--uid)
    - [.enable()](#gesturekitenable)
    - [.disable()](#gesturekitdisable)
    - [.on()](#gesturekitonevent-listener-once)
    - [.once()](#gesturekitonceevent-listener)
    - [.off()](#gesturekitoffevent-listener)
    - [.getListeners()](#gesturekitgetlistenersevent)
    - [.emit()](##gesturekitemitevent-arg1-arg2-)

- [Events](#events)
    - [load](#load)
    - [fail](#fail)
    - [enable](#enable)
    - [disable](#disable)
    - [recognize](#recognize)
    - [notrecognize](#noterecognize)
{'fraction_non_alphanumeric': 0.17461340206185566, 'fraction_numerical': 0.004510309278350515, 'mean_word_length': 4.016155088852988, 'pattern_counts': {'":': 0, '<': 6, '<?xml version=': 0, '>': 8, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2029661', 'n_tokens_mistral': 1111, 'n_tokens_neox': 1032, 'n_words': 208}