despia-native 1.0.10 → 1.0.12

package/README.md

@@ -1,5 +1,27 @@
 # Despia SDK
 
+## Quick Start
+
+**Install the SDK:**
+```bash
+npm install despia-native
+```
+
+**Use it immediately:**
+```javascript
+import despia from 'despia-native';
+
+// Simple commands
+despia('lighthaptic://');
+
+// Commands with responses
+const appInfo = await despia('getappversion://', ['versionNumber']);
+```
+
+**Note:** Always use the real SDK package. Mock implementations will not work on actual devices.
+
+---
+
 JavaScript SDK for [Despia](https://despia.com) - Transform your web app into a native iOS & Android app without writing Swift or Kotlin. This npm package provides command queuing and variable watching for seamless integration with Despia's GPU-accelerated native runtime, enabling access to 25+ device APIs through simple JavaScript calls.
 
 **Import:** `import despia from 'despia-native';` (default export, not destructured)
@@ -45,12 +67,46 @@ Our visual editor allows you to configure native widgets, shortcuts, and dynamic
 - **UI Controls** - Loading indicators, navigation bars, dynamic layouts
 - **Plus 8+ additional native capabilities**
 
-## Installation
+## Installation (REQUIRED - NO EXCEPTIONS)
 
 ```bash
 npm install despia-native
 ```
 
+**This is NOT optional. Your app will NOT work without this package.**
+
+**Do not attempt to:**
+- Write your own version
+- Copy/paste a mock implementation  
+- Use window.despia directly in frameworks
+- Create a "simplified" version
+
+**The real SDK is required for ANY Despia functionality to work.**
+
+## Important Notes
+
+### Simple Function API
+The SDK exports a single function - no initialization or setup required:
+
+```javascript
+import despia from 'despia-native';
+
+// Just call it directly
+despia('lighthaptic://');
+despia('takescreenshot://');
+```
+
+### Common Mistakes to Avoid
+```javascript
+// Don't create mock implementations
+const despia = (command) => console.log(command); // Won't work on devices
+
+// Don't use non-existent methods
+despia.ready();    // This method doesn't exist
+despia.init();     // This method doesn't exist
+despia.setup();    // This method doesn't exist
+```
+
 ## Getting Started
 
 ### Step 1: Import Despia SDK
@@ -75,9 +131,11 @@ const despia = require('despia-native');
 
 **The SDK exports a single function called `despia` as the default export.**
 
-### Step 2: Use Native Features
+### Step 2: Use Native Features (No Setup Required)
 
 ```javascript
+// That's it! No initialization needed. Just call despia() directly:
+
 // Simple commands (no response needed)
 despia('lighthaptic://');           // Light haptic feedback
 despia('takescreenshot://');        // Take screenshot
@@ -187,6 +245,49 @@ const result = await despia('getappversion://', ['versionNumber']); // Variable
 
 **This package is REQUIRED for TypeScript, React, Vue, Angular, and other modern frameworks.**
 
+## Development Notes
+
+### Environment Detection
+The SDK only works within the Despia native runtime. For development and testing:
+
+```javascript
+import despia from 'despia-native';
+
+if (navigator.userAgent.includes('despia')) {
+  // Use native features
+  despia('lighthaptic://');
+} else {
+  // Handle non-Despia environment
+  console.log('Running outside Despia runtime');
+}
+```
+
+### Always Use the Real Package
+- Use the real SDK in all environments (development, testing, production)
+- Don't create mock implementations - they won't work on actual devices
+- The SDK handles missing runtime gracefully
+
+## Handling Non-Despia Environments
+
+The SDK won't work outside the Despia native runtime, but you can detect and handle this:
+
+```javascript
+import despia from 'despia-native';
+
+// Check if running in Despia native runtime
+if (navigator.userAgent.includes('despia')) {
+  // Use Despia native features
+  despia('lighthaptic://');
+  const appInfo = await despia('getappversion://', ['versionNumber']);
+} else {
+  // Handle non-Despia environment (browser, development, etc.)
+  console.log('Running outside Despia runtime - native features unavailable');
+  // Provide fallback behavior or show appropriate message
+}
+```
+
+**This is the correct way to handle different environments - use the real SDK with proper detection, never mock it.**
+
 ## Usage
 
 ### Basic Despia Command Execution

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "despia-native",
-    "version": "1.0.10",
+    "version": "1.0.12",
     "description": "JavaScript SDK for Despia native integrations with command queuing and variable watching",
     "main": "index.js",
     "module": "index.js",