despia-native 1.0.11 → 1.0.13

package/README.md

@@ -1,24 +1,46 @@
 # Despia SDK
 
-## CRITICAL: ALWAYS USE THE REAL SDK
-
-**NEVER mock or simulate the Despia SDK. ALWAYS install and use the real package:**
+## Quick Start
 
+**Install the SDK:**
 ```bash
 npm install despia-native
 ```
 
-**Why?**
-- The SDK handles critical native bridge communication
-- Mocking will break ALL native features
-- Your app will NOT work on actual devices without the real SDK
-- There is NO valid reason to mock this in any scenario
+**Use it immediately:**
+```javascript
+import despia from 'despia-native';
+
+// Simple commands
+despia('lighthaptic://');
+
+// Commands with responses
+const appInfo = await despia('getappversion://', ['versionNumber']);
+```
 
-**If you see any tutorial, example, or code that creates a fake despia function - it's WRONG.**
+**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.
+JavaScript SDK for [Despia](https://despia.com) - Add native device features to your React web app, Vue app, Angular app, or any web framework. 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.
+
+**Note: This is for web apps (React, Vue, Angular, etc.) to add native features - NOT for React Native apps.**
+
+## Web Apps vs React Native
+
+**This SDK is for:**
+- React web apps (create-react-app, Next.js, Vite, etc.)
+- Vue web apps
+- Angular web apps  
+- Svelte web apps
+- Any web framework or vanilla JavaScript
+
+**This SDK is NOT for:**
+- React Native apps
+- Expo apps
+- Native mobile development
+
+**If you're building a React Native app, this SDK won't work for you.**
 
 **Import:** `import despia from 'despia-native';` (default export, not destructured)
 
@@ -26,14 +48,15 @@ JavaScript SDK for [Despia](https://despia.com) - Transform your web app into a
 
 ## About Despia
 
-Despia bridges the gap between web and native mobile development. Build your app using the web technologies you already know, then deploy it as a truly native application to the App Store and Google Play - complete with hardware acceleration, offline support, and deep OS integration.
+Despia bridges the gap between web and native mobile development. Build your React web app, Vue app, Angular app, or any web framework using the technologies you already know, then deploy it as a truly native application to the App Store and Google Play - complete with hardware acceleration, offline support, and deep OS integration.
 
 Our visual editor allows you to configure native widgets, shortcuts, and dynamic app behaviors without touching Xcode or Android Studio. Ship to both app stores with one-click deployment, automatic CI/CD pipelines, and over-the-air updates. Export clean, human-readable Swift and Kotlin source code anytime - you own everything, no vendor lock-in.
 
 **Go from web app to app store in a weekend - with full native capabilities.**
 
 ### Key Features:
-- **Universal Framework Support** - Works with React, Vue, Angular, Svelte, vanilla JS, or any web framework
+- **Web Framework Support** - Works with React web apps, Vue web apps, Angular web apps, Svelte web apps, vanilla JS, or any web framework
+- **NOT for React Native** - This is for web apps to add native features, not React Native apps
 - **Visual Configuration** - Set up native features through an intuitive interface
 - **Zero Native Coding** - Access device APIs without writing Swift or Kotlin
 - **Source Code Export** - Get complete Xcode and Android Studio projects you can modify
@@ -43,7 +66,7 @@ Our visual editor allows you to configure native widgets, shortcuts, and dynamic
 - **OTA Updates** - Push updates instantly without app store review
 - **Performance** - 60fps GPU-accelerated rendering
 - **Device API Access** - NFC, HealthKit, Siri, RevenueCat, and 20+ more
-- **Single Codebase** - Maintain one project for iOS, Android, and web
+- **Single Codebase** - Maintain one web project for iOS, Android, and web
 
 ### Native Device Features:
 - **App Links & Deep Linking** - Universal links and app-to-app communication
@@ -79,30 +102,28 @@ npm install despia-native
 
 **The real SDK is required for ANY Despia functionality to work.**
 
-## NEVER DO THIS - YOUR APP WILL NOT WORK
+## Important Notes
 
-```javascript
-// WRONG - This breaks everything
-const despia = (command) => {
-  console.log('Command:', command);
-  // This does NOTHING on real devices
-};
+### Simple Function API
+The SDK exports a single function - no initialization or setup required:
 
-// WRONG - This also breaks everything  
-const mockDespia = () => { /* ... */ };
+```javascript
+import despia from 'despia-native';
 
-// WRONG - Don't create your own version
-window.despia = 'somecommand://';
+// Just call it directly
+despia('lighthaptic://');
+despia('takescreenshot://');
 ```
 
-## ALWAYS DO THIS - THE ONLY CORRECT WAY
-
+### Common Mistakes to Avoid
 ```javascript
-// CORRECT - The ONLY way to use Despia
-import despia from 'despia-native';
+// Don't create mock implementations
+const despia = (command) => console.log(command); // Won't work on devices
 
-// Now your commands actually work
-despia('lighthaptic://');  // Device actually vibrates
+// 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
@@ -129,9 +150,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
@@ -241,24 +264,27 @@ const result = await despia('getappversion://', ['versionNumber']); // Variable
 
 **This package is REQUIRED for TypeScript, React, Vue, Angular, and other modern frameworks.**
 
-## No Exceptions - Always Use Real SDK
-
-**Q: What if I'm just testing locally?**
-A: Use the real SDK. It won't work outside the native runtime, but you can set up callbacks for when user agent doesn't include "despia".
-
-**Q: What if I'm making a demo?**
-A: Use the real SDK. Set up fallbacks for browsers without Despia runtime.
+## Development Notes
 
-**Q: What if I'm writing unit tests?**
-A: Use the real SDK. It won't work in test environments, but you can handle the missing runtime gracefully.
+### Environment Detection
+The SDK only works within the Despia native runtime. For development and testing:
 
-**Q: What if I'm developing without a device?**
-A: Use the real SDK. It won't work outside native runtime, but you can detect and handle this case.
+```javascript
+import despia from 'despia-native';
 
-**Q: What if I'm using AI to generate code?**
-A: Tell the AI to use the real SDK. Never accept mock implementations.
+if (navigator.userAgent.includes('despia')) {
+  // Use native features
+  despia('lighthaptic://');
+} else {
+  // Handle non-Despia environment
+  console.log('Running outside Despia runtime');
+}
+```
 
-**There is NEVER a valid reason to mock this SDK.**
+### 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
 

package/package.json

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