Update README, use npm-run-all for build

Author: arjan

README.md

@@ -1,34 +1,34 @@
 [![TypeScript version][ts-badge]][typescript-34]
 [![Node.js version][nodejs-badge]][nodejs]
-[![MIT][license-badge]][LICENSE]
+[![MIT][license-badge]][license]
 
 # speechmarkdown-js
 
 Speech Markdown grammar, parser, and formatters for use with JavaScript.
 
 Supported platforms:
-* amazon-alexa
-* amazon-polly
-* amazon-polly-neural
-* google-assistant
-* microsoft-azure
-* samsung-bixby
 
+- amazon-alexa
+- amazon-polly
+- amazon-polly-neural
+- google-assistant
+- microsoft-azure
+- samsung-bixby
 
 Find the architecture [here](./docs/architecture.md)
 
-
 ## Quick start
 
 ### SSML - Amazon Alexa
+
 Convert Speech Markdown to SSML for Amazon Alexa
 
 ```js
 const smd = require('speechmarkdown-js');
 
 const markdown = `Sample [3s] speech [250ms] markdown`;
 const options = {
-    platform: 'amazon-alexa'
+  platform: 'amazon-alexa',
 };
 
 const speech = new smd.SpeechMarkdown();
@@ -43,16 +43,16 @@ Sample <break time="3s"/> speech <break time="250ms"/> markdown
 </speak>
 ```
 
-
 ### SSML - Google Assistant
+
 Convert Speech Markdown to SSML for Google Assistant
 
 ```js
 const smd = require('speechmarkdown-js');
 
 const markdown = `Sample [3s] speech [250ms] markdown`;
 const options = {
-    platform: 'google-assistant'
+  platform: 'google-assistant',
 };
 
 const speech = new smd.SpeechMarkdown();
@@ -67,8 +67,8 @@ Sample <break time="3s"/> speech <break time="250ms"/> markdown
 </speak>
 ```
 
-
 ### Plain Text
+
 Convert Speech Markdown to Plain Text
 
 ```js
@@ -92,26 +92,27 @@ Sample speech markdown
 ### Options
 
 You can pass `options` into the constructor:
+
 ```js
 const smd = require('speechmarkdown-js');
 
 const markdown = `Sample [3s] speech [250ms] markdown`;
 const options = {
-    platform: 'amazon-alexa'
+  platform: 'amazon-alexa',
 };
 
 const speech = new smd.SpeechMarkdown(options);
 const ssml = speech.toSSML(markdown);
 ```
 
-
 Or in the methods `toSSML` and `toText`:
+
 ```js
 const smd = require('speechmarkdown-js');
 
 const markdown = `Sample [3s] speech [250ms] markdown`;
 const options = {
-    platform: 'amazon-alexa'
+  platform: 'amazon-alexa',
 };
 
 const speech = new smd.SpeechMarkdown();
@@ -120,120 +121,123 @@ const ssml = speech.toSSML(markdown, options);
 
 Available options are:
 
-* `platform` (string) - Determines the formatter to use to render SSML. Valid values are:
-    * "amazon-alexa"
-    * "amazon-polly"
-    * "amazon-polly-neural"
-    * "google-assistant"
-    * "microsoft-azure"
-    * "samsung-bixby"
+- `platform` (string) - Determines the formatter to use to render SSML. Valid values are:
 
-* `includeFormatterComment` (boolean) - Adds an XML comment to the SSML output indicating the formatter used. Default is `false`.
+  - "amazon-alexa"
+  - "amazon-polly"
+  - "amazon-polly-neural"
+  - "google-assistant"
+  - "microsoft-azure"
+  - "samsung-bixby"
 
-* `includeSpeakTag` (boolean) - Determines if the `<speak>` tag will be rendered in the SSML output. Default is `true`.
+- `includeFormatterComment` (boolean) - Adds an XML comment to the SSML output indicating the formatter used. Default is `false`.
 
-* `includeParagraphTag` (boolean) - Determines if the `<p>` tag will be rendered in the SSML output. Default is `false`.
+- `includeSpeakTag` (boolean) - Determines if the `<speak>` tag will be rendered in the SSML output. Default is `true`.
 
-* `preserveEmptyLines` (boolean) - keep empty lines in markdown in SSML. Default is `true`.
+- `includeParagraphTag` (boolean) - Determines if the `<p>` tag will be rendered in the SSML output. Default is `false`.
 
-* `escapeXmlSymbols` (boolean) - Currently only for `amazon-alexa`. Escape XML text. Default is `false`.
+- `preserveEmptyLines` (boolean) - keep empty lines in markdown in SSML. Default is `true`.
 
-* `voices` (object) - give custom names to voices and use that in your markdown:
+- `escapeXmlSymbols` (boolean) - Currently only for `amazon-alexa`. Escape XML text. Default is `false`.
 
-    ```json
-    {
-      "platform": "amazon-alexa",
-      "voices": {
-        "Scott": {"voice": {"name": "Brian"}},
-        "Sarah": {"voice": {"name": "Kendra"}}
-      }
+- `voices` (object) - give custom names to voices and use that in your markdown:
+
+  ```json
+  {
+    "platform": "amazon-alexa",
+    "voices": {
+      "Scott": { "voice": { "name": "Brian" } },
+      "Sarah": { "voice": { "name": "Kendra" } }
     }
-    ```
-
-    ```json
-    {
-      "platform": "google-assistant",
-      "voices": {
-            "Brian": {"voice": {"gender": "male", "variant": 1, "language": "en-US"}},
-            "Sarah": {"voice": {"gender": "female", "variant": 3, "language": "en-US"}},
-          }
+  }
+  ```
+
+  ```json
+  {
+    "platform": "google-assistant",
+    "voices": {
+      "Brian": {
+        "voice": { "gender": "male", "variant": 1, "language": "en-US" }
+      },
+      "Sarah": {
+        "voice": { "gender": "female", "variant": 3, "language": "en-US" }
+      }
     }
-    ```
-
+  }
+  ```
 
 ## Working on this project?
 
 ### Grammar
+
 The biggest place we need help right now is with the completion of the grammar and formatters.
 
 #### Short Format
 
-* [x] break
-* [x] emphasis - strong
-* [x] emphasis - moderate
-* [x] emphasis - none
-* [x] emphasis - reduced
-* [ ] ipa
-* [ ] sub
+- [x] break
+- [x] emphasis - strong
+- [x] emphasis - moderate
+- [x] emphasis - none
+- [x] emphasis - reduced
+- [ ] ipa
+- [ ] sub
 
 #### Standard Format
 
-* [x] address
-* [x] audio
-* [x] break (time)
-* [x] break (strength)
-* [x] characters / chars
-* [x] date
-* [x] defaults (section)
-* [x] disappointed
-* [x] disappointed (section)
-* [x] dj (section)
-* [x] emphasis
-* [x] excited
-* [x] excited (section)
-* [x] expletive / bleep
-* [x] fraction
-* [x] interjection
-* [x] ipa
-* [x] lang
-* [x] lang (section)
-* [x] mark
-* [x] newscaster (section)
-* [x] number
-* [x] ordinal
-* [x] telephone / phone
-* [x] pitch
-* [x] rate
-* [x] sub
-* [x] time
-* [x] unit
-* [x] voice
-* [x] voice (section)
-* [x] volume / vol
-* [x] whisper
+- [x] address
+- [x] audio
+- [x] break (time)
+- [x] break (strength)
+- [x] characters / chars
+- [x] date
+- [x] defaults (section)
+- [x] disappointed
+- [x] disappointed (section)
+- [x] dj (section)
+- [x] emphasis
+- [x] excited
+- [x] excited (section)
+- [x] expletive / bleep
+- [x] fraction
+- [x] interjection
+- [x] ipa
+- [x] lang
+- [x] lang (section)
+- [x] mark
+- [x] newscaster (section)
+- [x] number
+- [x] ordinal
+- [x] telephone / phone
+- [x] pitch
+- [x] rate
+- [x] sub
+- [x] time
+- [x] unit
+- [x] voice
+- [x] voice (section)
+- [x] volume / vol
+- [x] whisper
 
 ### Available scripts
 
-+ `clean` - remove coverage data, Jest cache and transpiled files,
-+ `build` - transpile TypeScript to ES5,
-+ `build:browser` - creates single file `./dist.browser/speechmarkdown.js` file for use in browser,
-+ `build:minify` - creates single file `./dist.browser/speechmarkdown.min.js` file for use in browser,
-+ `build:watch` - interactive watch mode to automatically transpile source files,
-+ `lint` - lint source files and tests,
-+ `test` - run tests,
-+ `test:watch` - interactive watch mode to automatically re-run tests
-
-
+- `clean` - remove coverage data, Jest cache and transpiled files,
+- `build` - perform all build tasks
+- `build:ts` - transpile TypeScript to ES5
+- `build:browser` - creates single file `./dist.browser/speechmarkdown.js` file for use in browser,
+- `build:minify` - creates single file `./dist.browser/speechmarkdown.min.js` file for use in browser,
+- `watch` - interactive watch mode to automatically transpile source files,
+- `lint` - lint source files and tests,
+- `test` - run tests,
+- `test:watch` - interactive watch mode to automatically re-run tests
 
 ## License
+
 Licensed under the MIT. See the [LICENSE](https://github.com/speechmarkdown/speechmarkdown-js/blob/master/LICENSE) file for details.
 
 [ts-badge]: https://img.shields.io/badge/TypeScript-3.4-blue.svg
 [typescript]: https://www.typescriptlang.org/
 [typescript-34]: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html
-
 [nodejs-badge]: https://img.shields.io/badge/Node.js->=%2010.13-blue.svg
 [nodejs]: https://nodejs.org/dist/latest-v10.x/docs/api/
-
 [license-badge]: https://img.shields.io/badge/license-MIT-blue.svg
 [license]: https://github.com/speechmarkdown/speechmarkdown-js/blob/master/LICENSE