README.md

# contactJS

The *Context Acquisition Toolkit for JavaScript* (contactJS) is a framework dealing with detection of contextual information on mobile devices.
It is based on a port of the *[Context Toolkit](http://contexttoolkit.sourceforge.net)* developed by A. Dey.

## Contents

Here be the table fo contents

## Installation

Download the latest release from GitHub. From the *./dist* folder copy the *contact.js* file to your project and add it to the require.js configuration file. For example:

```JavaScript
paths: {
    contactJS: 'lib/contactJS',
    ...
}
```

In your project you can now include contactJS by using require.js's define mechanism. For example:

```JavaScript
define(['contactJS'], function(contactJS)) {
    ...
}
```

## Components

### Discoverer

### Aggregator

### Attributes

### Widgets

### Interpreters

## Usage

### Discoverer

#### Initialization

#### Translations

### Aggregator

#### Initialization

### Widgets

#### Initialization

#### Custom Widgets