@hyperaudio/transcript-converter/README.md

Converts various formats of JSON transcripts to Hyperaudio format

# transcript-converter

![Node](https://img.shields.io/node/v/@hyperaudio/transcript-converter.svg?style=flat-square)
[![NPM](https://img.shields.io/npm/v/@hyperaudio/transcript-converter.svg?style=flat-square)](https://www.npmjs.com/package/@hyperaudio/transcript-converter)
[![Travis](https://img.shields.io/travis/hyperaudio/transcript-converter/master.svg?style=flat-square)](https://travis-ci.org/hyperaudio/transcript-converter)
[![David](https://img.shields.io/david/hyperaudio/transcript-converter.svg?style=flat-square)](https://david-dm.org/hyperaudio/transcript-converter)
[![Coverage Status](https://img.shields.io/coveralls/hyperaudio/transcript-converter.svg?style=flat-square)](https://coveralls.io/github/hyperaudio/transcript-converter)

> Hyperaudio HTML transcript to JSON converter

### Usage

```js
import transcriptConverter from '@hyperaudio/transcript-converter';

transcriptConverter(html).then(converted => {
  console.log(converted);
});
```

### Installation

Install via [yarn](https://github.com/yarnpkg/yarn)

	yarn add @hyperaudio/transcript-converter (--dev)

or npm

	npm install @hyperaudio/transcript-converter (--save-dev)


### configuration

You can pass in extra options as a configuration object (➕ required, ➖ optional, ✏️ default).

```js
import transcriptConverter from '@hyperaudio/transcript-converter';

```

➖ **property** ( type ) ` ✏️ default `
<br/> 📝 description
<br/> ❗️ warning
<br/> ℹ️ info
<br/> 💡 example

### methods

#### #name

```js
haJson

```

### Examples

See [`example`](example/script.js) folder or the [runkit](https://runkit.com/hyperaudio/transcript-converter) example.

### Builds

If you don't use a package manager, you can [access `@hyperaudio/transcript-converter` via unpkg (CDN)](https://unpkg.com/@hyperaudio/transcript-converter/), download the source, or point your package manager to the url.

`@hyperaudio/transcript-converter` is compiled as a collection of [CommonJS](http://webpack.github.io/docs/commonjs.html) modules & [ES2015 modules](http://www.2ality.com/2014/0
  -9/es6-modules-final.html) for bundlers that support the `jsnext:main` or `module` field in package.json (Rollup, Webpack 2)

The `@hyperaudio/transcript-converter` package includes precompiled production and development [UMD](https://github.com/umdjs/umd) builds in the [`dist` folder](https://unpkg.com/ha-json/dist/). They can be used directly without a bundler and are thus compatible with many popular JavaScript module loaders and environments. You can drop a UMD build as a [`<script>` tag](https://unpkg.com/@hyperaudio/transcript-converter) on your page. The UMD builds make `@hyperaudio/transcript-converter` available as a `window.transcriptConverter` global variable.

### License

The code is available under the [MIT](LICENSE) license.

### Contributing

We are open to contributions, see [CONTRIBUTING.md](CONTRIBUTING.md) for more info.

### Misc

This module was created using [generator-module-boilerplate](https://github.com/duivvv/generator-module-boilerplate).