coinley-pay 0.15.0 → 0.17.0

package/README.md

@@ -1,8 +1,36 @@
-# React + Vite
+# coinley-pay
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+React and vanilla JavaScript SDK for Coinley checkout.
 
-Currently, two official plugins are available:
+## React / Vite Install
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+Use the package ESM entry for React apps:
+
+```jsx
+import { CoinleyPayment } from 'coinley-pay';
+import 'coinley-pay/dist/style.css';
+```
+
+The React checkout is lazy-loaded from the root entry, so Vite apps do not pull
+the full wallet/payment stack into the initial application chunk.
+
+## PWA Builds
+
+The SDK ESM build is split into smaller chunks so `vite-plugin-pwa` can precache
+it with Workbox's default 2 MiB per-file limit. In the current build, the largest
+React checkout chunk is about 1.3 MB minified.
+
+Do not import the standalone vanilla CDN bundle in React/Vite apps. The vanilla
+bundle is intentionally self-contained for script-tag usage and is much larger
+than the split ESM build.
+
+If an app intentionally uses the standalone vanilla bundle with PWA precaching,
+configure Workbox explicitly:
+
+```js
+VitePWA({
+  workbox: {
+    maximumFileSizeToCacheInBytes: 7 * 1024 * 1024
+  }
+})
+```