# ShelfNetwork JS SDK

> **WARNING**:  This package name is deprecated and won't be maintained in the future.
Use [@shelf.network/js-sdk](https://www.npmjs.com/package/@shelf.network/js-sdk) instead.

## Overview

`shelf-network-sdk` is a client-side Javascript library for ShelfNetwork distributed auction platform.

## Getting Started

1. Add ShelfNetwork SDK to your project:

    ```sh
    npm install -S shelf-network-sdk
    ```

1. Create an SDK instance:

    ```js
    import { ShelfNetwork } from 'shelf-network-sdk'

    const sdk = await ShelfNetwork.create({
      gatewayUrl: 'https://api.stagings.shelf.network'
    })
    ```

1. Log into your account:

    ```js
    const token = await sdk.auth.getToken('my@email.com', '<my password>')
    sdk.useToken(token)
    ```

1. Read the [docs](https://eauction.gitlab.io/js-sdk/index.html)

## Development

Check out our [Development Guide](https://eauction.gitlab.io/js-sdk/index.html#development-guide).

## License

shelf-network-sdk is licensed under an [Apache-2.0 license](./LICENSE).