browser-sdk/README.md

javascript SDK for the lightelligence-platform

<a href="https://lightelligence.io" align="right">
    <img src="/resources/logo.png" alt="logo" title="logo" align="right" />
</a>

# BrowserSDK

[![Coverage Status](https://coveralls.io/repos/github/woozar/browser-sdk/badge.svg?branch=master)](https://coveralls.io/github/woozar/browser-sdk?branch=master)
[![npm (scoped)](https://img.shields.io/npm/v/browser-sdk.svg)](https://www.npmjs.com/package/browser-sdk)

> The Lightelligence API JavaScript Client for the Browser

## Installation

```
npm install woozar/browser-sdk
```

## Features

The BrowserSDK allows you to access most of the Lightelligence API end-points and manages the
user authentication flow for your client side application.

## Usage

In order to authenticate with the BrowserSDK you will need to create an 
application via our [Lightelligence portal](https://portal.lightelligence.io/developer)
and obtain a public client ID.

```js
import BrowserSDK, { Device } from '@lightelligence/browser-sdk';

const browserSDK = new BrowserSDK({
  environment: 'prod', // Target enviroment (either `dev`, `preview` or `prod`)
  clientId: '', // The public client ID of the application your created in our [Lightelligence portal](https://portal.lightelligence.io/developer)
});

browserSDK.getCurrentUser().then(user => {

  if ( !user ) { return browserSDK.login(); }
  
  // Will print all devices of the tenant
  Device.getDevices().then( devices => console.log( devices ) );
  
} )
```

Check out [the API reference](https://lightelligence-io.github.io/browser-sdk/) 
to see the full documentation.

## License

MIT