@innovastudio/contentbox 1.5.82 → 1.5.83

package/readme.txt

@@ -31,18 +31,35 @@ or run the example project:
 
         A browser window will open with the ContentBox.js example running.
 
-        - The ContentBox initiation can be found in 'src/index.js'.
+        - The ContentBox initialization can be found in 'src/index.js'.
         - The Node.js server code is in 'server.js'.
 
 NOTE:
 
+- The AI Assistant is an optional feature that you can enable or disable.
+    Please refer to the AI Assistant documentation:
+
+    https://demo.innovastudio.com/docs/AI-Assistant.pdf
+
 - To use the AI Assistant:
-    1. Obtain the OpenAI API key from https://openai.com
+    1. Obtain the OpenAI API key from https://openai.com.
     2. Update the .env file with your API key.
 
-       Or if you're using PHP, update the 'sendcommand.php' file with your API key:
+       Alternatively, if you're using PHP, update the 'api/config.php' file with your API key:
+
+            $OPENAI_API_KEY = 'YOUR_API_KEY';
 
-        define('OPENAI_API_KEY', 'YOUR_API_KEY_HERE');
+    3. Initialization
+
+            const builder = new ContentBox({
+                    sendCommandUrl: '/sendcommand',
+            });
+
+       If you're using PHP:
+
+            const builder = new ContentBox({
+                    sendCommandUrl: '/sendcommand',
+            });
 
 - For speech recognition (if dictation is enabled), the browser's built-in
     speech recognition is used. However, certain browsers may not support this feature.
@@ -50,31 +67,60 @@ NOTE:
     Obtain the Deepgram API key from https://deepgram.com.
     An example of using Deepgram is provided in the example project.
     Obtain the Deepgram API key and update the .env file with your API key.
-    Then enable the 'speechTranscribeUrl' parameter in the ContentBox initiation (src/index.js).
+    Then enable the 'speechTranscribeUrl' parameter in the ContentBox initialization (src/index.js).
 
-- The AI Assistant is an optional feature that you can enable or disable.
-    Please refer to the AI Assistant documentation.
+- To use the AI image generation:
+    1. Obtain the OpenAI API key from https://getimg.ai/tools/api.
+    2. Update the .env file with your API key.
 
-- AI Assistant documentation
+       Alternatively, if you're using PHP, update the 'api/config.php' file with your API key:
 
-    https://demo.innovastudio.com/docs/AI-Assistant.pdf
+            $GETIMG_API_KEY = 'YOUR_API_KEY';
 
+    3. Initialization
 
-______________________
+            const builder = new ContentBox({
+                textToImageUrl: '/texttoimage', 
+                upscaleImageUrl: '/upscaleimage',
+                imageAutoUpscale: true,
+            });
+    
+       If you're using PHP:
+
+            const builder = new ContentBox({
+                textToImageUrl: 'api/texttoimage.php', 
+                upscaleImageUrl: 'api/upscaleimage.php',
+                imageAutoUpscale: true,
+            });
+
+- Please add your own security to the API endpoints (public/api/)!
+
+- You can try a full working example by running the example project (please refer to the previous instructions).
 
 
+______________________
+SOURCE CODE PACKAGE
+
 If you have the ContentBox source code:
 
 - The source code is located in the 'src/contentbox/' folder.
   When you run the project, you can try modifying the source code, and
   the changes will be applied, and the browser will refresh automatically.
 
-- When finished, to build the JS code that you can use in production, run:
+- When finished, to build the JavaScript code for production use, update the package.json file:
+
+    {
+    "name": "@innovastudio/contentbox",
+    "type": "module",
+
+    }
+
+  Then, run:
 
     > npm run build
 
   The minified JS will be generated in the folder: 'public/contentbuilder/contentbuilder.min.js'.
-  You can test it by opening, for example, 'public/example.html'.
+  You can test it by opening: 'public/example.html'.
   If you're using Visual Studio Code, right-click on the 'example.html' file and select "Open with Live Server".
 
 - To build CSS from SCSS files, run: