@abra-promotions/webhooks-for-tapcart 1.0.1 → 2.0.0-beta.1

package/README.md

@@ -1,27 +1,27 @@
-# @abra/tapcart-webhooks
+# @abra-promotions/webhooks-for-tapcart
 
-Abra Tapcart webhook integrations for promotions, cart management, and activation.
+Abra Tapcart webhook integration for promotions.
 
 ## Installation
 
 ```bash
-npm install @abra/tapcart-webhooks
+npm install @abra-promotions/webhooks-for-tapcart
 ```
 
 ## Usage
 
-useTapcart, and tapcartData are properties provided by tapcart for every block.
+React is passed in so the package has no imports of its own (a second copy of React would break hooks). useTapcart and tapcartData are provided by tapcart for every block.
 
 ### useAbra
 
 Main hook for Abra promotion logic, use it within tapcart to parse any product into it's discounted version.
 
 ```javascript
-import { useAbra } from "@abra/tapcart-webhooks";
+import { useAbra } from "@abra-promotions/webhooks-for-tapcart";
 
 const MyComponent = ({ useTapcart, tapcartData }) => {
   //Initialize
-  const { abra } = useAbra({ useTapcart, tapcartData });
+  const { abra } = useAbra({ React, useTapcart, tapcartData });
 
   // Use  for promotion logic
   const productWithDiscountedPrice = abra.getProductWithDiscount(product);
@@ -29,46 +29,9 @@ const MyComponent = ({ useTapcart, tapcartData }) => {
 };
 ```
 
-### useAbraActivate
-
-Hook for activation logic, add it to the homepage, will enable and disable promotions
-
-```javascript
-import { useAbraActivate } from "@abra/tapcart-webhooks";
-
-const MyComponent = ({ useTapcart, tapcartData }) => {
-  useAbraActivate({
-    useTapcart,
-    tapcartData,
-    discountCode, // (Optional) used for activating private promotions
-    displayToast, // (Optional) whether will show a banner after a promotion is activated
-    redirectPath, // (Optional) Wheather it should redirect to a specific page after activating
-    testDeviceId, // (Optional) Allows activating test promotion code on this device
-    testPromotionCode, // (Optional) Code that will activate on test device
-    autoApplyDiscount, // (Optional) Make it false for automatic discounts
-  });
-
-  return <div>...</div>;
-};
-```
-
-### useAbraCart / AbraCartBlock
-
-Cart-specific functionality: control discounts, attributes and gift items. load it in the cart page.
-
-```javascript
-import { useAbraCart } from "@abra/tapcart-webhooks";
-
-const CartComponent = ({ useTapcart, tapcartData }) => {
-  useAbraCart({ useTapcart, tapcartData });
-  return <div>...</div>;
-};
-```
-
 ## Requirements
 
-- React 16.8+
-- @tapcart/mobile-components ^0.7.25
+- React 16.8+ (passed in as `React`)
 
 ## License