shopar-plugin 0.0.4 → 0.0.5-alpha.1

package/README.md

@@ -21,7 +21,7 @@ Powered and developed by DeepAR.
 
 Create an account in the [ShopAR Dashboard](https://dashboard.shopar.ai).
 
-Add some models to your account. Make sure the models' client IDs match the product IDs on your website.
+Add some models to your account. Make sure the models' plugin SKUs match the product IDs on your website.
 
 ## Installation
 
@@ -32,7 +32,7 @@ There are two distinct ways of integrating the plugin: via Script tag and via NP
 Add the following script to your HTML.
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/shopar-plugin@0.0.4/dist/shopar-plugin.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/shopar-plugin@{{VERSION}}/dist/shopar-plugin.js"></script>
 ```
 
 It is possible to use a different CDN instead of [jsDelivr](https://www.jsdelivr.com/) (e.g. [cdnjs](https://cdnjs.com/), [unpkg](https://www.unpkg.com/)), or even a relative path if the plugin is distributed as a static asset to your app. Just make sure to set the `baseUrl` parameter accordingly (see [setup options](#shoparpluginsetupoptions) for more details).
@@ -62,7 +62,7 @@ Paste the following snippet in your HTML.
 ```
 
 - Replace `API_KEY` with your API key. You can find it in the [ShopAR Dashboard](https://dashboard.shopar.ai).
-- Replace `PRODUCT_ID` with the ID of the product. Make sure it matches the client ID in the [ShopAR Dashboard](https://dashboard.shopar.ai).
+- Replace `PRODUCT_ID` with the ID of the product. Make sure it matches the plugin SKU of the model in the [ShopAR Dashboard](https://dashboard.shopar.ai).
 - Replace `TARGET_ELEMENT` with the HTML element you wish to embed the plugin's UI into.
 
 To change the look-and-feel of the plugin's UI, modify the following CSS classes:
@@ -117,7 +117,7 @@ Options used for the plugin setup:
 - `baseUrl` (optional)
   - Type: `string`
   - If provided, defines where the additional ShopAR plugin files are fetched from.
-  - Default value: `https://cdn.jsdelivr.net/npm/shopar-plugin@0.0.4/dist`
+  - Default value: `https://cdn.jsdelivr.net/npm/shopar-plugin@{{VERSION}}/dist`
 
 ## License