@srsergio/taptapp-ar 1.1.2 → 1.1.4

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.
Files changed (2) hide show
  1. package/README.md +24 -0
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -101,6 +101,30 @@ import { OfflineCompiler } from '@srsergio/taptapp-ar';
101
101
  // ... same compiler code as before ...
102
102
  ```
103
103
 
104
+ ### 📦 Using a Pre-compiled `.taar` File
105
+
106
+ If you already have a pre-compiled `.taar` file (generated by the offline compiler or provided by another developer), you can skip the JIT compilation entirely by passing it directly to the tracker:
107
+
108
+ ```typescript
109
+ // Using a pre-compiled .taar file (skips JIT compilation)
110
+ const tracker = await startTracking({
111
+ targetSrc: './my-precompiled-target.taar' // Direct .taar file
112
+ });
113
+ ```
114
+
115
+ **Benefits of using pre-compiled `.taar` files:**
116
+ - ⚡ **Instant startup**: No compilation delay on first load.
117
+ - 📱 **Better for low-end devices**: Avoids CPU-intensive compilation.
118
+ - 🔄 **Consistent results**: Same binary across all deployments.
119
+
120
+ **When to use JIT vs Pre-compiled:**
121
+ | Use Case | Recommended Approach |
122
+ | :--- | :--- |
123
+ | Development / Prototyping | JIT (just use `.jpg`/`.png`) |
124
+ | Production / Low-end devices | Pre-compiled `.taar` |
125
+ | Dynamic user-uploaded images | JIT |
126
+ | Static marketing campaigns | Pre-compiled `.taar` |
127
+
104
128
  ---
105
129
 
106
130
  ## 🎥 Runtime Usage (AR Tracking)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@srsergio/taptapp-ar",
3
- "version": "1.1.2",
3
+ "version": "1.1.4",
4
4
  "description": "Ultra-fast Augmented Reality (AR) SDK for Node.js and Browser. Image tracking with 100% pure JavaScript, zero-dependencies, and high-performance compilation.",
5
5
  "keywords": [
6
6
  "augmented reality",
@@ -22,7 +22,7 @@
22
22
  "webxr",
23
23
  "natural-feature-tracking"
24
24
  ],
25
- "author": "Sergio Lázaro <slazaro.dev@gmail.com>",
25
+ "author": "Sergio Lázaro <sergio@taptapp.xyz>",
26
26
  "license": "Fair Source-0.9",
27
27
  "repository": {
28
28
  "type": "git",