# `@findeth/hdnode`

![Version](https://img.shields.io/npm/v/@findeth/hdnode) ![License](https://img.shields.io/github/license/FindETH/hdnode) [![Travis CI](https://travis-ci.com/FindETH/hdnode.svg?branch=master)](https://travis-ci.com/FindETH/hdnode) [![codecov](https://codecov.io/gh/FindETH/hdnode/branch/master/graph/badge.svg)](https://codecov.io/gh/FindETH/hdnode)


`@findeth/hdnode` is a library used by FindETH, used for mnemonic phrases and HD wallet key derivation. It is used in the desktop, web and CLI applications, that can be found here:

- [Desktop](https://github.com/FindETH/desktop)
- [Web](https://github.com/FindETH/web)
- [CLI](https://github.com/FindETH/cli)

**Note**: This is a work-in-progress version of FindETH, and is **not** production-ready. For the current version of FindETH, please refer to [this repository](https://github.com/Mrtenz/FindETH/tree/master).

---

## Installation

You can install `@findeth/hdnode` with Yarn (recommended) or NPM:

```
$ yarn add @findeth/hdnode
```

```
$ npm install @findeth/hdnode
```

## Getting Started

TODO

## Development

Install dependencies with `yarn`:

```
$ yarn
```

To run automated tests, use the `test` script:

```
$ yarn run lint
```


To build the library, use the `build` script:

```
$ yarn run build
```