@volr/react-ui 0.1.94 → 0.1.96

package/README.md

@@ -46,6 +46,7 @@ Volr provides a simple, Stripe-like payment experience for Web3 applications.
 
 ```tsx
 import { useVolrPay } from '@volr/react-ui';
+// Or from @volr/react if not using UI components
 
 function CheckoutButton() {
   const { pay } = useVolrPay();
@@ -250,20 +251,43 @@ function DepositButton() {
 
 ### useVolrPay
 
-Hook for payment operations.
+Hook for payment operations with PaymentModal integration.
 
 ```tsx
 import { useVolrPay } from '@volr/react-ui';
 
 const {
-  pay,                      // (options: PayOptions) => Promise<PaymentHandle>
+  pay,                // (options: PayOptions) => Promise<PaymentHandle>
+  checkPayment,       // (id: string) => Promise<PaymentResult>
+  getPaymentHistory,  // (options?) => Promise<{ payments, total }>
+  isPaymentInProgress // boolean
+} = useVolrPay();
+
+// PaymentHandle returned from pay()
+interface PaymentHandle {
+  id: string;
+  status: PaymentStatus;
+  wait: () => Promise<PaymentResult>;  // Wait for completion
+  cancel: () => Promise<void>;          // Cancel (PENDING only)
+}
+```
+
+### useVolrPaymentApi (Advanced)
+
+Headless payment API for advanced use cases (no UI).
+
+```tsx
+import { useVolrPaymentApi } from '@volr/react-ui';
+
+const {
+  createPayment,            // (options: PayOptions) => Promise<PaymentResult>
   checkPayment,             // (id: string) => Promise<PaymentResult>
   getPaymentHistory,        // (options?) => Promise<{ payments, total }>
   updatePaymentToProcessing,// (id, txId) => Promise<PaymentResult>
   cancelPayment,            // (id) => Promise<PaymentResult>
   pollPaymentStatus,        // (id) => Promise<PaymentResult>
   isLoading,                // boolean
-} = useVolrPay();
+} = useVolrPaymentApi();
 ```
 
 ### useVolrModal