@web-ar-studio/webar-engine-sdk 1.0.16 โ†’ 1.0.18

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 (6) hide show
  1. package/README.md +54 -10
  2. package/dist/index.d.ts +340 -290
  3. package/dist/index.js +1 -1
  4. package/dist/index.mjs +1 -1
  5. package/package.json +54 -45
  6. package/LICENSE +0 -28
package/README.md CHANGED
@@ -1,10 +1,54 @@
1
- # webar-engine-sdk
2
- WAS CV Lib - SDK of the WebAR CV Lib
3
-
4
- Installation instructions for the package and sample projects featuring image, QR, face, webxr and AR 360 tracking can be found at https://github.com/WebAR-Studio/webar-sdk-samples
5
-
6
- You can use our library for free for non-commercial and educational purposes. For commercial use, you can purchase any tariff from https://web-ar.studio/en/pricing/. There are no limitations on the number of project scans, and the library itself is continuously improved.
7
-
8
- In the repository with examples, you can find a key for local project launches. To obtain a key for public builds, please contact us at https://discord.gg/XQpe5P48 or https://t.me/was_team.
9
-
10
- Our library is fully typed, so after installation, you can easily see all possible types and arguments.
1
+ # webar-engine-sdk
2
+ Official WebAR.Studio SDK for browser-based AR tracking (image, QR, face, WebXR, and AR 360). ๐Ÿš€
3
+
4
+ ๐Ÿ”— Samples repo (ready-to-run demos):
5
+ https://github.com/WebAR-Studio/webar-sdk-samples
6
+
7
+ ## โœจ Why try it
8
+ - โœ… Real CV tracking, not a mock
9
+ - โšก Fast setup without boilerplate
10
+ - ๐ŸŽฏ Proof-of-concepts in minutes
11
+ - ๐ŸŒ Browser-first AR (no app installs)
12
+
13
+ ## ๐Ÿงญ Who this is for
14
+ - ๐Ÿง‘โ€๐Ÿ’ป Web developers building immersive sites
15
+ - ๐ŸŽจ Marketing and creative teams running AR campaigns
16
+ - ๐Ÿ›๏ธ E-commerce teams prototyping try-on or product previews
17
+ - ๐ŸŽ“ Educators and students learning AR
18
+ - ๐Ÿš€ Startups validating ideas quickly
19
+
20
+ ## ๐Ÿงฉ Tracking modes at a glance
21
+ | Mode | Marker needed | Best for | Browser support |
22
+ | --- | --- | --- | --- |
23
+ | `ar-360-tracking` | โŒ | 360 tours, panoramas | Modern mobile browsers |
24
+ | `face-tracking` | โŒ | filters, try-ons | Front-camera supported |
25
+ | `image-tracking` | โœ… | posters, packaging | WebGL/WebRTC capable |
26
+ | `qrcode-tracking` | โœ… | QR-triggered AR | Any camera-enabled |
27
+ | `webxr-tracking` | โŒ | plane placement | WebXR + HTTPS |
28
+
29
+ ## ๐Ÿ†š SDK vs samples (quick comparison)
30
+ | You need | Use |
31
+ | --- | --- |
32
+ | Core CV tracking engine | `webar-engine-sdk` |
33
+ | Ready-to-run examples | `webar-sdk-samples` |
34
+
35
+ ## ๐Ÿš€ Quick start
36
+ Install the package and follow the runnable examples in the samples repo:
37
+ https://github.com/WebAR-Studio/webar-sdk-samples
38
+
39
+ ## ๐Ÿ’ธ Pricing and limits
40
+ - ๐ŸŽ“ Free for educational and non-commercial use. We provide a key on request via support.
41
+ - ๐Ÿ’ผ Commercial use: $8/month with no limits on views/scans and continuous library improvements with new algorithms.
42
+ - ๐Ÿงช Test key to get started (limit: 1000 requests per month per domain):
43
+ ```
44
+ dca17806a3135ec541fff4a1109be543f1994bcc96effaf790d7add0fc0dc6ba
45
+ ```
46
+
47
+ ## ๐Ÿ“ฎ Support and API key requests
48
+ For any questions about the library or API keys, contact us here:
49
+ - https://t.me/was_team
50
+ - support@web-ar.studio
51
+ - https://discord.gg/4q5dbAb4GZ
52
+
53
+ ## โœ… Typed API
54
+ The library is fully typed, so you can explore available types and arguments after installation.