# @spruceid/sprucekit

> An identity solution that enables SSI to JS/TS apps.

Latest version **0.1.0** (published 2023-06-28) · Apache-2.0 OR MIT license · 0 weekly downloads

## Install

```sh
npm install @spruceid/sprucekit
pnpm add @spruceid/sprucekit
yarn add @spruceid/sprucekit
bun add @spruceid/sprucekit
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2023-06-28 |
| First published | 2023-06-28 |
| Weekly downloads | 0 |
| License | Apache-2.0 OR MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 19 |
| Unpacked size | 5.9 MB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Author | Spruce Systems, Inc. |
| Maintainers | obstropolos, jszersze, skgbafa, chunningham, wycjs, sbihel, w4ll3, xtheosirian, krhoda |

## Links

- npm: https://www.npmjs.com/package/@spruceid/sprucekit
- Repository: https://github.com/spruceid/sprucekit
- Homepage: https://github.com/spruceid/sprucekit#readme
- Issues: https://github.com/spruceid/sprucekit/issues
- npm.io page: https://npm.io/package/@spruceid/sprucekit

## Dependencies (19)

- [url](https://npm.io/package/url.md) ^0.11.0
- [siwe](https://npm.io/package/siwe.md) ^2.1.4
- [axios](https://npm.io/package/axios.md) ^0.27.2
- [assert](https://npm.io/package/assert.md) ^2.0.0
- [buffer](https://npm.io/package/buffer.md) ^6.0.3
- [ethers](https://npm.io/package/ethers.md) ^6.6.0
- [events](https://npm.io/package/events.md) ^3.3.0
- [browser](https://npm.io/package/browser.md) ^0.2.6
- [process](https://npm.io/package/process.md) ^0.11.10
- [cross-env](https://npm.io/package/cross-env.md) 5.0.5
- [stream-http](https://npm.io/package/stream-http.md) ^3.2.0
- [lodash.merge](https://npm.io/package/lodash.merge.md) ^4.6.2
- [os-browserify](https://npm.io/package/os-browserify.md) ^0.3.0
- [path-browserify](https://npm.io/package/path-browserify.md) ^1.0.1
- [https-browserify](https://npm.io/package/https-browserify.md) ^1.0.0
- [stream-browserify](https://npm.io/package/stream-browserify.md) ^3.0.0
- [@spruceid/sprucekit-core](https://npm.io/package/@spruceid/sprucekit-core.md) 0.1.0
- [@spruceid/sprucekit-wasm](https://npm.io/package/@spruceid/sprucekit-wasm.md) 0.0.1
- [@metamask/detect-provider](https://npm.io/package/@metamask/detect-provider.md) ^1.2.0

## Recent versions

- 0.1.0 (latest) — 2023-06-28

## README

# SpruceKit Client SDK

## Quick Start

You can add SpruceKit to your app using your favorite package manager.

```bash
yarn add @spruceid/sprucekit
# or
npm install @spruceid/sprucekit
# or
pnpm add @spruceid/sprucekit
```

and then you can use it in your app.

```js
import { SpruceKit } from "@spruceid/sprucekit";

const buttonHandler = async () => {
  const sk = new SpruceKit();
  const session = await sk.signIn();
  const address = sk.address();
};
```

## Documentation

For full documentation, see the [SpruceKit Docs](https://docs.sprucekit.id)

---
_Source: https://npm.io/package/@spruceid/sprucekit · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._