Skip to content
This repository has been archived by the owner on Jan 14, 2020. It is now read-only.

buttercup/buttercup-core-web

Repository files navigation

Buttercup core library - for the web

Web-based build of the Buttercup core library.

Buttercup Join the chat at https://gitter.im/buttercup-pw/buttercup-core-web Build Status

Buttercup-web

For the most part this library inherits all functionality from Buttercup core, but it also contains some web-specific functionality in the way of tools and rigs.

API reference:

Deprecated: Core-web will slowly be integrated completely with Buttercup core

This repository will be made obsolete by the task buttercup/buttercup-core#181.

Usage

Buttercup core-web is a UMD module, so you can import it using AMD or CommonJS styles, or by simply including it as script on a webpage (exposes Buttercup and Buttercup.Web on the window).

Importing Buttercup into other projects is easy:

import { Archive } from "buttercup-web";
// or
const { Archive } = require("buttercup-web");

When using react-native, there's a special version of the script which should be used when Dropbox, for example, may be used:

import { Archive, Web as ButtercupWeb } from "buttercup-web/dist/react-native-buttercup.min.js";
const { DropboxDatasource } = ButtercupWeb;

Cryptography

The core-web library utilises current technology to encrypt and hash and very high speed, and this is supported by only the newest browsers.

Buttercup-core-web, like Buttercup-core, uses iocane for text encryption and decryption. iocane uses 256bit AES encryption to securely store password archives, and is completely compatible with most modern browsers.