guideai-app 0.3.1 → 0.3.3
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.
- package/README.md +13 -2
- package/dist/GuideAI.js +1 -1
- package/dist/GuideAI.js.map +1 -1
- package/dist/components/TranscriptBox.d.ts +1 -1
- package/dist/metric/metadata-tracker.d.ts +4 -1
- package/package.json +1 -1
- package/components/Styles.d.ts +0 -3
- package/types/index.d.ts +0 -24
package/README.md
CHANGED
|
@@ -10,7 +10,18 @@ A React component that provides an AI-powered guide assistant for any webpage. F
|
|
|
10
10
|
npm install guideai-app
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
### 2.
|
|
13
|
+
### 2. Environment Variables (Optional)
|
|
14
|
+
|
|
15
|
+
If you plan to use Gemini AI features, set the following environment variable:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
# In your .env file or environment
|
|
19
|
+
GEMINI_API_KEY=your_gemini_api_key_here
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
**Note**: The package will work without this key, but some AI features may be limited.
|
|
23
|
+
|
|
24
|
+
### 3. Basic Usage
|
|
14
25
|
|
|
15
26
|
```jsx
|
|
16
27
|
import React from 'react';
|
|
@@ -31,7 +42,7 @@ function App() {
|
|
|
31
42
|
}
|
|
32
43
|
```
|
|
33
44
|
|
|
34
|
-
###
|
|
45
|
+
### 4. Advanced Configuration
|
|
35
46
|
|
|
36
47
|
```jsx
|
|
37
48
|
import React from 'react';
|