1 | # transcript-parser
|
2 |
|
3 | ![Node](https://img.shields.io/node/v/@hyperaudio/transcript-parser.svg?style=flat-square)
|
4 | [![NPM](https://img.shields.io/npm/v/@hyperaudio/transcript-parser.svg?style=flat-square)](https://www.npmjs.com/package/@hyperaudio/transcript-parser)
|
5 | [![Travis](https://img.shields.io/travis/hyperaudio/transcript-parser/master.svg?style=flat-square)](https://travis-ci.org/hyperaudio/transcript-parser)
|
6 | [![David](https://img.shields.io/david/hyperaudio/transcript-parser.svg?style=flat-square)](https://david-dm.org/hyperaudio/transcript-parser)
|
7 | [![Coverage Status](https://img.shields.io/coveralls/hyperaudio/transcript-parser.svg?style=flat-square)](https://coveralls.io/github/hyperaudio/transcript-parser)
|
8 |
|
9 | > Hyperaudio HTML transcript to JSON parser
|
10 |
|
11 | ### Usage
|
12 |
|
13 | ```js
|
14 | import transcriptParser from '@hyperaudio/transcript-parser';
|
15 |
|
16 | transcriptParser(html).then(converted => {
|
17 | console.log(converted);
|
18 | });
|
19 | ```
|
20 |
|
21 | ### Installation
|
22 |
|
23 | Install via [yarn](https://github.com/yarnpkg/yarn)
|
24 |
|
25 | yarn add @hyperaudio/transcript-parser (--dev)
|
26 |
|
27 | or npm
|
28 |
|
29 | npm install @hyperaudio/transcript-parser (--save-dev)
|
30 |
|
31 |
|
32 | ### configuration
|
33 |
|
34 | You can pass in extra options as a configuration object (➕ required, ➖ optional, ✏️ default).
|
35 |
|
36 | ```js
|
37 | import transcriptParser from '@hyperaudio/transcript-parser';
|
38 |
|
39 | ```
|
40 |
|
41 | ➖ **property** ( type ) ` ✏️ default `
|
42 | <br/> 📝 description
|
43 | <br/> ❗️ warning
|
44 | <br/> ℹ️ info
|
45 | <br/> 💡 example
|
46 |
|
47 | ### methods
|
48 |
|
49 | #### #name
|
50 |
|
51 | ```js
|
52 | haJson
|
53 |
|
54 | ```
|
55 |
|
56 | ### Examples
|
57 |
|
58 | See [`example`](example/script.js) folder or the [runkit](https://runkit.com/hyperaudio/transcript-parser) example.
|
59 |
|
60 | ### Builds
|
61 |
|
62 | If you don't use a package manager, you can [access `@hyperaudio/transcript-parser` via unpkg (CDN)](https://unpkg.com/@hyperaudio/transcript-parser/), download the source, or point your package manager to the url.
|
63 |
|
64 | `@hyperaudio/transcript-parser` is compiled as a collection of [CommonJS](http://webpack.github.io/docs/commonjs.html) modules & [ES2015 modules](http://www.2ality.com/2014/0
|
65 | -9/es6-modules-final.html) for bundlers that support the `jsnext:main` or `module` field in package.json (Rollup, Webpack 2)
|
66 |
|
67 | The `@hyperaudio/transcript-parser` 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-parser) on your page. The UMD builds make `@hyperaudio/transcript-parser` available as a `window.transcriptParser` global variable.
|
68 |
|
69 | ### License
|
70 |
|
71 | The code is available under the [MIT](LICENSE) license.
|
72 |
|
73 | ### Contributing
|
74 |
|
75 | We are open to contributions, see [CONTRIBUTING.md](CONTRIBUTING.md) for more info.
|
76 |
|
77 | ### Misc
|
78 |
|
79 | This module was created using [generator-module-boilerplate](https://github.com/duivvv/generator-module-boilerplate).
|