guideai-app 0.2.2 → 0.2.4

package/GuideAI.d.ts

@@ -7,7 +7,11 @@ export interface GuideAIProps {
         right?: string;
         bottom?: string;
         left?: string;
+        marginTop?: string;
+        marginRight?: string;
+        marginBottom?: string;
         marginLeft?: string;
+        transform?: string;
     };
     onError?: (error: string | Error, context?: string) => void;
 }

package/README.md

@@ -1,6 +1,6 @@
 # Guide AI
 
-A React component that provides AI-powered guidance with screen capture and voice interaction capabilities.
+A React component that provides AI-powered guidance with voice interaction and element highlighting capabilities.
 
 ## Installation
 
@@ -19,12 +19,55 @@ function App() {
   return (
     <div>
       <GuideAI 
-        apiKey="your-openai-api-key"
-        shortcutKey="k"
+        organizationKey="your-organization-key"
         position={{ bottom: '2rem', right: '2rem' }}
         onError={(error) => console.error(error)}
       />
     </div>
   );
 }
+```
+
+## Props
+
+| Prop | Type | Required | Description |
+|------|------|----------|-------------|
+| `organizationKey` | `string` | Yes | Your organization key for workflows |
+| `position` | `object` | No | Positioning configuration for the component |
+| `onError` | `function` | No | Error handler callback |
+
+### Position Object
+
+The `position` prop accepts an object with CSS positioning properties:
+
+```typescript
+position?: {
+  top?: string;
+  right?: string;
+  bottom?: string;
+  left?: string;
+  marginTop?: string;
+  marginRight?: string;
+  marginBottom?: string;
+  marginLeft?: string;
+  transform?: string;
+}
+```
+
+### Examples
+
+**Fixed positioning:**
+```jsx
+<GuideAI 
+  organizationKey="your-org-key"
+  position={{ bottom: '4rem', left: '50%', marginLeft: '-30px' }}
+/>
+```
+
+**Corner positioning:**
+```jsx
+<GuideAI 
+  organizationKey="your-org-key"
+  position={{ top: '20px', right: '20px' }}
+/>
 ```

package/dist/GuideAI.d.ts

@@ -1,15 +1,4 @@
 import React from 'react';
-export interface GuideAIProps {
-    apiKey?: string;
-    organizationKey: string;
-    position?: {
-        top?: string;
-        right?: string;
-        bottom?: string;
-        left?: string;
-        marginLeft?: string;
-    };
-    onError?: (error: string | Error, context?: string) => void;
-}
+import { GuideAIProps } from './types/GuideAI.types';
 declare const GuideAI: (props: GuideAIProps) => React.JSX.Element | null;
 export default GuideAI;