react-native-wakeword 1.0.25 → 1.0.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +38 -4
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,12 +1,46 @@
1
- DaVoice.io Voice commands / Wake words / keyword detection npm for Android and IOS.
1
+ ## About this package:
2
+ DaVoice.io Voice commands / Wake words / Voice to Intent / keyword detection npm for Android and IOS.
2
3
 
3
4
  Contact us at info@DaVoice.io
4
5
 
6
+ ## What's in this package
7
+
8
+ ### This package includes
9
+ #### 1. "Wake Word" (also known as: "keyword detection" and "phrase spotting") api to enable ios and android applications.
10
+ #### 2. "Speech to Intent" (also known as: "voice commands" and "phrase spotting") very similar to "Wake Word" however mainly used to use speech command to control the application rather than waking up the application.
11
+
5
12
  ## Installation
6
13
  npm install react-native-wakeword
7
14
 
8
- # On IOS add:
9
- pod 'KeyWordDetection', :path => '../node_modules/react-native-wakeword'
15
+ ## Githhub examples:
10
16
 
11
- Checkout examples on:
17
+ ### Checkout examples on:
12
18
  https://github.com/frymanofer/ReactNative_WakeWordDetection
19
+
20
+
21
+ ## FAQ:
22
+
23
+ ### What is a wake word?
24
+
25
+ A wake word is a keyword that activates your device, like "Hey Siri" or "OK Google".
26
+
27
+ ### What is a Speech to Intent?
28
+
29
+ Speech to Intent refers to the ability to recognize a spoken word or phrase
30
+ and directly associate it with a specific action or operation within an application.
31
+
32
+ Unlike a "wake word," which typically serves to activate or wake up the application,
33
+ Speech to Intent goes further by enabling complex interactions and functionalities
34
+ based on the recognized intent behind the speech.
35
+
36
+ For example, a wake word like "Hey App" might activate the application, while Speech
37
+ to Intent could process a phrase like "Play my favorite song" or "Order a coffee" to
38
+ execute corresponding tasks within the app.
39
+ Speech to Intent is often triggered after a wake word activates the app, making it a key
40
+ component of more advanced voice-controlled applications. This layered approach allows for
41
+ seamless and intuitive voice-driven user experiences.
42
+
43
+ ### How accurate is the platform?
44
+
45
+ Our platform ensures 99.99%+ accuracy in various environments.
46
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "react-native-wakeword",
3
- "version": "1.0.25",
3
+ "version": "1.0.27",
4
4
  "description": "Voice/Wake-word detection library for React Native",
5
5
  "main": "wakewords/index.js",
6
6
  "types": "wakewords/index.d.ts",