# @sherl/sdk

[![Release](https://github.com/Winzana/sherl-sdk-js/workflows/Release/badge.svg?branch=master&event=push)](https://github.com/Winzana/sherl-sdk-js/actions?query=workflow%3ARelease)
[![Version](https://img.shields.io/npm/v/@sherl/sdk)](https://www.npmjs.com/package/@sherl/sdk)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

Sherl SDK for JavaScript.

## Sherl

Sherl is a low-code platform created by [Winzana](https://winzana.com).

## Getting started

### Installation

#### Install as NPM package

```
npm install @sherl/sdk
```

#### Add script in browser

The script is available in the [releases section](https://github.com/Winzana/sherl-sdk-js/releases).

```html
<script type="text/javascript" src="sherl-sdk.min.js"></script>

<!-- or through a CDN like jsDelivr -->
<script src="https://cdn.jsdelivr.net/npm/@sherl/sdk@latest/_bundles/sherl-sdk.min.js"></script>
```

### Configuration

Before calling any other methods, you need to initialize the SDK by calling `init`:

```js
// Import with require
const Sherl = require('@sherl/sdk');

// OR import syntax
import * as Sherl from '@sherl/sdk';

// OR `window.sherl` for browsers

Sherl.init({
  apiKey: 'YOUR_API_KEY',
  apiSecret: 'YOUR_API_SECRET',
});
```

## Contributions

See [CONTRIBUTING.md](CONTRIBUTING.md)