shelf-network-sdkdeprecated

shelf-network-sdk is a client-side SDK for Shelf.Network platform.

Usage no npm install needed!

<script type="module">
  import shelfNetworkSdk from 'https://cdn.skypack.dev/shelf-network-sdk';
</script>

README

ShelfNetwork JS SDK

WARNING: This package name is deprecated and won't be maintained in the future. Use @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:

    npm install -S shelf-network-sdk

  2. Create an SDK instance:

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

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

  3. Log into your account:

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

  4. Read the docs

Development

Check out our Development Guide.

License

shelf-network-sdk is licensed under an Apache-2.0 license.