@shoppexio/storefront 0.1.0 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.3.0
+
+- Publish the active Storefront SDK runtime under `@shoppexio/storefront`.
+- Include cart coupon validation types for `{ productId, variantId }`.
+
+## 0.1.1
+
+- Package metadata and release polish.
+
 ## 0.1.0
 
 - first public storefront package release

package/README.md

@@ -1,8 +1,12 @@
 # @shoppexio/storefront
 
-Public npm package for the Shoppex Storefront SDK.
+Official JavaScript storefront SDK for Shoppex.
 
-This package is the storefront-facing SDK for:
+Use this package when you want to embed Shoppex products, cart behavior, and hosted checkout into a custom frontend.
+
+## Good fit
+
+Use this package for:
 
 - product loading
 - cart state
@@ -26,3 +30,25 @@ const products = await shoppex.getProducts();
 shoppex.addToCart(products.data?.[0]?.uniqid ?? '', 'default', 1);
 await shoppex.checkout();
 ```
+
+## Coupon validation
+
+Use the options form when validating a coupon for a selected product variant:
+
+```ts
+const result = await shoppex.validateCoupon('SAVE10', {
+  productId: 'prod_abc123',
+  variantId: 'variant_lifetime',
+});
+```
+
+Calling `validateCoupon(code)` without options validates against the current SDK cart. Affiliate/referral codes are separate and should use `validateAffiliateCode` or `applyAffiliateCode`.
+
+## Not this package
+
+If you want the authenticated Developer API wrapper for backend integrations, use `@shoppexio/sdk`. Do not ship `@shoppexio/sdk` in a browser bundle; use this Storefront SDK for headless storefronts.
+
+## Docs
+
+- Storefront docs: [docs.shoppex.io/sdk/introduction](https://docs.shoppex.io/sdk/introduction)
+- Installation: [docs.shoppex.io/sdk/installation](https://docs.shoppex.io/sdk/installation)