@kazeblockchain/krypton-js/README.md

Javascript libraries for kaze wallet using https://github.com/kazechainio/kazewallet/blob/master/js/wallet.js as the original source.

<p align="center">
  <img
    src="https://kaze.solutions/content/static/img/general/logo.svg"
    width="125px;">
</p>

<h1 align="center">krypton-js</h1>

<p align="center">
  Krypton JavaScript SDK for for the KAZE blockchain platform.
</p>

<p align="center">
  <a href="https://circleci.com/gh/kazeblockchain/krypton-js">
    <img src="https://circleci.com/gh/kazeblockchain/krypton-js.svg?style=svg">
  </a>
</p>

## Overview

This the Krypton Wallet's JS SDK for the KAZE blockchain platform. It is currently in use by [Krypton](https://github.com/kazeblockchain/verto-wallet/).

Visit the [docs](https://kaze.solutions/krypton-js) to learn how to use this library!

## Getting started

### Installation

Install the package using:

```js
npm i @kazeblockchain/krypton-js
```

### Build

```js
npm run build:dev
```

### Tests

```js
npm run test
```

### Docs

We use Docusaurus for our docs website. The docs are stores in `./docs` while the main website and its configuration is in `./website`.

```bash
cd website
npm install
npm run start
```

### Typescript

The typescript declaration files are included _(no need of any @types/...)_.

## License

- Open-source [MIT](https://github.com/KAZEBLOCKCHAIN/krypton-js/blob/master/LICENSE).