fedoragold-mnemonics/README.md

![image](https://user-images.githubusercontent.com/34389545/35821974-62e0e25c-0a70-11e8-87dd-2cfffeb6ed47.png)

# Fedoragold Mnemonics Helper

![Prerequisite](https://img.shields.io/badge/node-%3E%3D12-blue.svg) [![Documentation](https://img.shields.io/badge/documentation-yes-brightgreen.svg)](https://www.fedoragold.com) [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://git.fedoragold.com/jojapoppa/fedoragold-mnemonics.git/graphs/commit-activity) [![License: GPL-3.0](https://img.shields.io/badge/License-GPL--3.0-yellow.svg)](https://git.fedoragold.com/jojapoppa/fedoragold-mnemonics.git)

This package contains the code paths necessary to encode and/or decode a wallet seed to Mnemonic words or back again.

Adapted for use with FedoraGold from the Turtlecoin project.

## Initialization

### TypeScript

```typescript
import { Mnemonics } from 'fedoragold-mnemonics'
```

### JavaScript

```javascript
const Mnemonics = require('fedoragold-mnemonics').Mnemonics
```

### Documentation

You can find the full documentation for this library [here](https://www.fedoragold.com)