# dexie-skynet-sync-protocol

> ## Synopsis

Latest version **1.0.0** (published 2021-07-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install dexie-skynet-sync-protocol
pnpm add dexie-skynet-sync-protocol
yarn add dexie-skynet-sync-protocol
bun add dexie-skynet-sync-protocol
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-07-31 |
| First published | 2021-07-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 3.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | selchenkov |

## Links

- npm: https://www.npmjs.com/package/dexie-skynet-sync-protocol
- npm.io page: https://npm.io/package/dexie-skynet-sync-protocol

## Dependencies (6)

- [dexie](https://npm.io/package/dexie.md) ^v3.2.0-beta.1
- [cross-env](https://npm.io/package/cross-env.md) 5.0.5
- [skynet-js](https://npm.io/package/skynet-js.md) ^4.0.9-beta
- [dexie-syncable](https://npm.io/package/dexie-syncable.md) ^3.0.0-beta.10
- [short-unique-id](https://npm.io/package/short-unique-id.md) ^4.3.3
- [dexie-observable](https://npm.io/package/dexie-observable.md) ^3.0.0-beta.11

## Recent versions

- 1.0.0 (latest) — 2021-07-31

## README

# dexie-skynet-sync-protocol

## Synopsis

This is a simple implementation of the [ISyncProtocol](https://github.com/dfahlander/Dexie.js/wiki/Dexie.Syncable.ISyncProtocol) to work with [Skynet SkyDB](https://siasky.net/docs/?javascript--browser#skydb) and [Sia Skynet](https://siasky.net/)

## Installation

```bash
npm install --save dexie-skynet-sync-protocol
```

## Basic Usage

```js
import Dexie from 'dexie'
import 'dexie-observable'
import 'dexie-syncable'

// import skynet sync protocol
import 'dexie-skynet-sync-protocol'

...
// at some point you want to start sync with skynet

db.syncable.connect('skynet', 'https://siasky.net', {
    seed: '[user-seed]', // for genKeyPairFromSeed
    poolInterval: 10000, // milliseconds
    rootItem: '[any-unique-name]'
})

```

## Contributing

If you feel you can help in any way, be it with documentation, examples, extra testing, or new features please open an [issue](https://github.com/ivan-selchenkov-otg/dexie-skynet-sync-protocol/issues) or [pull request](https://github.com/ivan-selchenkov-otg/dexie-skynet-sync-protocol/pulls).
If you have any questions feel free to open an [issue](https://github.com/ivan-selchenkov-otg/dexie-skynet-sync-protocol/issues) with your question.

## License
[MIT License](./LICENSE)

---
_Source: https://npm.io/package/dexie-skynet-sync-protocol · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._