# Deprecated: Use the `authereum` package instead.

# @authereum/sdk

> The [Authereum](https://authereum.org) JavaScript SDK

[![License](http://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/@authereum/sdk/master/LICENSE)
[![dependencies Status](https://david-dm.org/@authereum/sdk/status.svg)](https://david-dm.org/@authereum/sdk)
[![NPM version](https://badge.fury.io/js/authereum.svg)](http://badge.fury.io/js/authereum)

## Install

```bash
npm install @authereum/sdk
```

## Getting started

```bash
import Authereum from '@authereum/sdk'

const authereum = new Authereum(/* options */)
```

## Development

Watch and build:

```bash
npm run dev
```

Build:

```bash
npm run build
```

Lint:

```bash
npm run lint
```

## Test

```bash
npm test
```

## FAQ

- Q: I added a function to the Authereum SDK **and already removed the node_modules from each dir and ran `lerna bootstrap`**, but the frontend is unable to use the function. Additionally, the function is not found anywhere in the node_modules/authereum/dist directory

 - A: `lerna` is probably using the npm module `authereum`, as opposed to the local `authereum` module. This is because the `authereum` version in /packages/frontend/package.json matches an existing npm module. (I assume) `lerna` prioritizes live packages, so when you run `lerna bootstrap` and it runs `npm install`, it is installing from npm. **To fix it, you need to bump the local version of `authereum` in /packages/authereum/package.json and then copy that version into the `package.json` in /packages/frontend/package.json. Then rerun `lerna bootstrap` (or just `lerna link` if you are in the frontend directory).**

## License

[MIT](LICENSE)