Merge branch 'master' of github.com:nativescript-community/texttospeech

README.md

@@ -1,20 +1,19 @@
-[![npm](https://img.shields.io/npm/v/nativescript-community/texttospeech.svg)](https://www.npmjs.com/package/nativescript-community/texttospeech)
-[![npm](https://img.shields.io/npm/dt/nativescript-community/texttospeech.svg?label=npm%20downloads)](https://www.npmjs.com/package/nativescript-community/texttospeech)
+[![npm](https://img.shields.io/npm/v/@nativescript-community/texttospeech.svg)](https://www.npmjs.com/package/@nativescript-community/texttospeech)
+[![npm](https://img.shields.io/npm/dt/@nativescript-community/texttospeech.svg?label=npm%20downloads)](https://www.npmjs.com/package/@nativescript-community/texttospeech)
 
 # @nativescript-community/texttospeech :loudspeaker:
 
 A Text to Speech NativeScript plugin for Android & iOS
 
 #### Native Controls
 
-- Android - [TextToSpeech](https://developer.android.com/reference/android/speech/tts/TextToSpeech.html)
-- iOS - [AVSpeechSynthesizer](https://developer.apple.com/reference/avfoundation/avspeechsynthesizer)
+-   Android - [TextToSpeech](https://developer.android.com/reference/android/speech/tts/TextToSpeech.html)
+-   iOS - [AVSpeechSynthesizer](https://developer.apple.com/reference/avfoundation/avspeechsynthesizer)
 
 ## Installation
 
 Run the following command from the root of your project:
 
-
 ```
 tns plugin add @nativescript-community/texttospeech
 ```
@@ -37,41 +36,41 @@ import { TNSTextToSpeech, SpeakOptions } from '@nativescript-community/texttospe
 const TTS = new TNSTextToSpeech();
 
 const speakOptions: SpeakOptions = {
-  text: 'Whatever you like', /// *** required ***
-  speakRate: 0.5, // optional - default is 1.0
-  pitch: 1.0, // optional - default is 1.0
-  volume: 1.0, // optional - default is 1.0
-  locale: 'en-GB', // optional - default is system locale,
-  finishedCallback: Function, // optional
+    text: 'Whatever you like', /// *** required ***
+    speakRate: 0.5, // optional - default is 1.0
+    pitch: 1.0, // optional - default is 1.0
+    volume: 1.0, // optional - default is 1.0
+    locale: 'en-GB', // optional - default is system locale,
+    finishedCallback: Function, // optional
 };
 
 // Call the `speak` method passing the SpeakOptions object
 TTS.speak(speakOptions).then(
-  () => {
-    // everything is fine
-  },
-  (err) => {
-    // oops, something went wrong!
-  }
+    () => {
+        // everything is fine
+    },
+    (err) => {
+        // oops, something went wrong!
+    }
 );
 ```
 
 #### API
 
-- `speak(options: SpeakOptions): Promise<any>` - start speaking with the given options
-- `pause(): void` - pause the speech
-- `resume(): void` - resume the speech
-- `destroy(): void` - release resources for the speech synthesizer/engine
-
-- `SpeakOptions = {}`
-  - `text: string` ** required **
-  - `queue?: boolean = false`
-  - `pitch?: number = 1.0`
-  - `speakRate?: number = 1.0`
-  - `volume?: number = 1.0`
-  - `locale?: string = default system locale`
-  - `language?: string = default system language` ** Android only **
-  - `finishedCallback?: Function`
+-   `speak(options: SpeakOptions): Promise<any>` - start speaking with the given options
+-   `pause(): void` - pause the speech
+-   `resume(): void` - resume the speech
+-   `destroy(): void` - release resources for the speech synthesizer/engine
+
+-   `SpeakOptions = {}`
+    -   `text: string` ** required **
+    -   `queue?: boolean = false`
+    -   `pitch?: number = 1.0`
+    -   `speakRate?: number = 1.0`
+    -   `volume?: number = 1.0`
+    -   `locale?: string = default system locale`
+    -   `language?: string = default system language` ** Android only **
+    -   `finishedCallback?: Function`
 
 If you wish to set a custom locale, you need to provide a valid BCP-47 code, e.g. `en-US`. If you wish to set only a custom language (without a preferred country code), you need to provide a valid ISO 639-1 language code. If both are set, the custom locale will be used.
 
@@ -81,28 +80,28 @@ Example with language code only:
 
 ```js
 const speakOptions: SpeakOptions = {
-  text: 'Whatever you like', // *** required ***
-  language: 'en', // english language will be used
+    text: 'Whatever you like', // *** required ***
+    language: 'en', // english language will be used
 };
 ```
 
 Example with locale:
 
 ```js
 const speakOptions: SpeakOptions = {
-  text: 'Whatever you like', // *** required ***
-  locale: 'en-AU', // australian english language will be used
+    text: 'Whatever you like', // *** required ***
+    locale: 'en-AU', // australian english language will be used
 };
 ```
 
 ### Tip
 
-- The speech synthesizer takes a moment to initialize on most devices. A simple way to get around this (tested in the demo app) is to create your new instance of the TNSTextToSpeech and then immediately call the `init` method . This will force the synthesizer to "warm up" . Now when you call the `speak` method for your app's functionality it will already have "warmed up" the synthesizer so the delay should be minimal.
-  It's possible this "Warm up" process could be put into the plugin source itself, I don't have time to do it right now but welcome any contribution that is well tested to make this the default behavior of the synthesizers.
+-   The speech synthesizer takes a moment to initialize on most devices. A simple way to get around this (tested in the demo app) is to create your new instance of the TNSTextToSpeech and then immediately call the `init` method . This will force the synthesizer to "warm up" . Now when you call the `speak` method for your app's functionality it will already have "warmed up" the synthesizer so the delay should be minimal.
+    It's possible this "Warm up" process could be put into the plugin source itself, I don't have time to do it right now but welcome any contribution that is well tested to make this the default behavior of the synthesizers.
 
 ### Android Only Methods
 
-- `getAvailableLanguages(): Promise<Array<Language>>;` - returns an array of available languages (use to prevent using non-existing language/local codes)
+-   `getAvailableLanguages(): Promise<Array<Language>>;` - returns an array of available languages (use to prevent using non-existing language/local codes)
 
 ## Credits