README.hbs

# @selfkey/node-lib

> Selfkey sdk for third party integrations written in Node.js

[![NPM][npm-icon]][npm-url]
[![CircleCI](https://circleci.com/gh/SelfKeyFoundation/selfkey-lib/tree/master.svg?style=svg)](https://circleci.com/gh/SelfKeyFoundation/selfkey-lib/tree/master)

[npm-icon]: https://img.shields.io/npm/v/@selfkey/node-lib
[npm-url]: https://npmjs.org/package/@selfkey/node-lib


## Contents

- [Install](#install)
- [Usage](#usage)
- [API](#api)
- [Examples](#examples)
- [License](#license)

## Install

Requires [Node](https://nodejs.org/en/) version 10 or above

```sh
npm install --save @selfkey/node-lib
```

<a name="usage"></a>

## Usage

```js
const sk = require('@selfkey/node-lib');
```

or ES6 syntax

```js
import sk from '@selfkey/node-lib';
```

<a name="api"></a>
## API
{{>main}}

<a name="examples"></a>

## Examples

- Login with Selfkey for kycc user https://github.com/SelfKeyFoundation/relying-party-kycc-demo
- Login with Selfkey for direct integrations https://github.com/SelfKeyFoundation/relying-party-direct-demo
- Marketplace integrations with kycc as middleware https://github.com/SelfKeyFoundation/relying-party-mp-kycc-demo

<a name="license"></a>
## License

[The GPL-3.0 License](http://opensource.org/licenses/GPL-3.0)

Copyright (c) 2018 SelfKey Foundation <https://selfkey.org/>