# bitcluster

> Simplified Client-Side Encryption

Latest version **2.0.1** (published 2020-02-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install bitcluster
pnpm add bitcluster
yarn add bitcluster
bun add bitcluster
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2020-02-06 |
| First published | 2018-02-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 4.3 KB |
| Known vulnerabilities | 0 (+6 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Drew Long |
| Maintainers | drewlong |
| Keywords | bitcluster, crypto-js, encryption, client-side, decryption |

## Links

- npm: https://www.npmjs.com/package/bitcluster
- Repository: https://github.com/drewlong/bitcluster
- Homepage: https://github.com/drewlong/bitcluster#readme
- Issues: https://github.com/drewlong/bitcluster/issues
- npm.io page: https://npm.io/package/bitcluster

## Dependencies (4)

- [s](https://npm.io/package/s.md) ^1.0.0
- [nanoid](https://npm.io/package/nanoid.md) ^2.1.11
- [qrious](https://npm.io/package/qrious.md) ^4.0.2
- [crypto-js](https://npm.io/package/crypto-js.md) ^3.1.9-1

## Alternatives

- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads

## Recent versions

- 2.0.1 (latest) — 2020-02-06
- 2.0.0 — 2020-02-05
- 1.2.1 — 2018-11-15
- 1.2.0 — 2018-03-25
- 1.1.2 — 2018-03-18
- 1.1.1 — 2018-03-18
- 1.1.0 — 2018-03-18
- 1.0.1 — 2018-02-23
- 1.0.0 — 2018-02-23

## README

# Bitcluster

Bitcluster is a simple wrapper for Crypto-JS that makes client-side encryption painless, and validation easier.

Install:

`npm install --save bitcluster`

To encrypt:
```
// using node

var Bitcluster = require('bitcluster')

// or React:

import Bitcluster from 'bitcluster';

var obj = {
  data: 'whatever data you'd like to encrypt',
  key: 'your super secret password'
}

var res = Bitcluster.encrypt(obj)

// returns:
{
  h1: 'Hash 1',
  h2: 'Hash 2',
  hash: 'The hash used to verify contents when decrypting'
}
```

To decrypt:
```
// using node

var Bitcluster = require('bitcluster')

// or React:

import Bitcluster from 'bitcluster';

var obj = {
  h1: 'Hash 1',
  h2: 'Hash 2',
  hash: 'The hash used to verify contents when decrypting',
  pass: 'super secret password'
}

var res = Bitcluster.decrypt(obj)

// returns:
{
  data: 'whatever you encrypted',
  status: 'OK'
}

```

It's  as simple as that: completely client-side encryption.

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