@innovastudio/contentbox 1.5.71 → 1.5.73

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 (4) hide show
  1. package/package.json +2 -2
  2. package/public/contentbox/contentbox.esm.js +247 -57
  3. package/public/contentbox/contentbox.min.js +2 -2
  4. package/readme.txt +29 -42
package/readme.txt CHANGED
@@ -1,8 +1,8 @@
1
- ContentBox.js 5.5.8
1
+ ContentBox.js 5.6
2
2
 
3
3
  To get started, please refer to the documentation:
4
4
 
5
- https://demo.innovastudio.com/docs/ContentBox.pdf
5
+ https://demo.innovastudio.com/docs/ContentBox.pdf
6
6
 
7
7
 
8
8
  To try the example:
@@ -16,30 +16,7 @@ or
16
16
  http://localhost/.../public/example.php (PHP example)
17
17
 
18
18
 
19
- NOTE:
20
-
21
- - To use the AI Assistant:
22
- 1. Obtain the OpenAI API Key from https://openai.com
23
- 2. Update the 'sendcommand.php' file with your API Key:
24
-
25
- define('OPENAI_API_KEY', 'YOUR_API_KEY_HERE');
26
-
27
- - For speech recognition (when dictation is enabled), the browser's built-in
28
- speech recognition is used. However, certain browsers may not support this feature.
29
- We recommend using Deepgram for browser compatibility and accuracy.
30
- Obtain the Deepgram API Key from https://deepgram.com.
31
- An example of using Deepgram is provided in the Node.js example below.
32
-
33
- - The AI Assistant is an optional feature that you can enable or disable.
34
- Please refer to the AI Assistant documentation:
35
-
36
- https://demo.innovastudio.com/docs/AI-Assistant.pdf
37
-
38
-
39
- _____________________________________________
40
-
41
-
42
- To run the project (Node.js example):
19
+ or run the example project:
43
20
 
44
21
  1. Install the project dependencies:
45
22
 
@@ -48,32 +25,42 @@ To run the project (Node.js example):
48
25
  Note: To run this command, you need to have NPM installed.
49
26
  Download & install NPM from https://nodejs.org/en/download/.
50
27
 
51
- 2. OPTIONAL: (if you want to use the AI Assistant feature)
52
-
53
- Update the .env file with your OpenAI and Deepgram API Keys:
54
- - Obtain the OpenAI API Key from https://openai.com
55
- - Obtain the Deepgram API Key from https://deepgram.com (optional. See note below.)
56
-
57
- 3. Run the project:
28
+ 2. Run the project:
58
29
 
59
30
  > npm start
60
31
 
61
32
  A browser window will open with the ContentBox.js example running.
62
33
 
34
+ - The ContentBox initiation can be found in 'src/index.js'.
35
+ - The Node.js server code is in 'server.js'.
63
36
 
64
- NOTE:
37
+ NOTE:
65
38
 
66
- - The ContentBox initiation can be found in 'src/index.js'.
39
+ - To use the AI Assistant:
40
+ 1. Obtain the OpenAI API key from https://openai.com
41
+ 2. Update the .env file with your API key.
67
42
 
68
- - The Node.js server code is in 'server.js'.
43
+ Or if you're using PHP, update the 'sendcommand.php' file with your API key:
69
44
 
70
- - Using Deepgram for speech recognition is optional but recommended.
71
- Alternatively, you can use the browser's built-in speech recognition.
72
- To use the browser's built-in speech recognition, just disable/remove
73
- the 'speechTranscribeUrl' parameter when initiating the ContentBox (src/index.js).
45
+ define('OPENAI_API_KEY', 'YOUR_API_KEY_HERE');
74
46
 
47
+ - For speech recognition (if dictation is enabled), the browser's built-in
48
+ speech recognition is used. However, certain browsers may not support this feature.
49
+ We recommend using Deepgram for browser compatibility and accuracy.
50
+ Obtain the Deepgram API key from https://deepgram.com.
51
+ An example of using Deepgram is provided in the example project.
52
+ Obtain the Deepgram API key and update the .env file with your API key.
53
+ Then enable the 'speechTranscribeUrl' parameter in the ContentBox initiation (src/index.js).
75
54
 
76
- _____________________________________________
55
+ - The AI Assistant is an optional feature that you can enable or disable.
56
+ Please refer to the AI Assistant documentation.
57
+
58
+ - AI Assistant documentation
59
+
60
+ https://demo.innovastudio.com/docs/AI-Assistant.pdf
61
+
62
+
63
+ ______________________
77
64
 
78
65
 
79
66
  If you have the ContentBox source code:
@@ -86,7 +73,7 @@ If you have the ContentBox source code:
86
73
 
87
74
  > npm run build
88
75
 
89
- The minified JS will be generated in the folder: 'public/contentbox/contentbox.min.js'.
76
+ The minified JS will be generated in the folder: 'public/contentbuilder/contentbuilder.min.js'.
90
77
  You can test it by opening, for example, 'public/example.html'.
91
78
  If you're using Visual Studio Code, right-click on the 'example.html' file and select "Open with Live Server".
92
79