@fashioninsights-zalando/fcp-client/README.md

# fcp-client-js
Fashion Content Platform - JavaScript SDK

## Getting started

### Install

#### with NPM

```
npm install --save @fashioninsights-zalando/fcp-client
```

#### with Yarn

```
yarn add @fashioninsights-zalando/fcp-client
```


### Usage

#### Content Insights Client

```
import { ContentInsightsApi } from 'fcp-client'
...

const client = new ContentInsightsApi({ host: 'http://fcp-host/', tenantID: 'MY_FCP_TENANT_ID' })
...
```

#### Influencers Client

```
import { InfluencersClient } from 'fcp-client'
...

const client = new InfluencersClient({ host: 'http://fcp-host/', tenantID: 'MY_FCP_TENANT_ID' })
...
```

## Development

2. Building
  * Run `yarn` to get the project's dependencies
  * Run `yarn run build` to produce minified version.
3. Development mode
  * Having all the dependencies installed run `yarn run dev`. This command will generate an non-minified version and will run a watcher so you get the compilation on file change.
4. Running the tests
  * Run `yarn run test`

## Scripts

* `yarn run build` - produces production version under the `lib` folder
* `yarn run dev` - produces development version and runs a watcher
* `yarn run test` - well ... it runs the tests :)