@openreceive/browser 0.4.5 → 0.4.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -2
- package/dist/{chunk-ZTB2TOBO.js → chunk-CPVYEWVM.js} +28 -24
- package/dist/headless.d.ts +25 -23
- package/dist/headless.js +1 -1
- package/dist/index.js +1 -1
- package/dist/styles.css +1 -1
- package/package.json +4 -4
- package/skills/integrate-openreceive/references/btcpay.md +1 -1
- package/skills/integrate-openreceive/references/django.md +20 -6
- package/skills/integrate-openreceive/references/fastapi.md +20 -6
- package/skills/integrate-openreceive/references/fastify.md +20 -6
- package/skills/integrate-openreceive/references/laravel.md +20 -6
- package/skills/integrate-openreceive/references/next.md +20 -6
- package/skills/integrate-openreceive/references/node.md +20 -6
- package/skills/integrate-openreceive/references/php.md +20 -6
- package/skills/integrate-openreceive/references/rails.md +20 -6
- package/skills/integrate-openreceive/references/woocommerce.md +24 -1
package/README.md
CHANGED
|
@@ -1,6 +1,30 @@
|
|
|
1
1
|
# @openreceive/browser
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Build a Bitcoin Lightning checkout that fits your own design. OpenReceive
|
|
4
|
+
provides browser helpers for creating checkout sessions, following payment
|
|
5
|
+
status, displaying QR codes, and opening wallets, plus a headless checkout
|
|
6
|
+
engine for custom payment screens.
|
|
7
|
+
|
|
8
|
+
OpenReceive supports optional swaps from **USDT, USDC, SOL, and ETH** through
|
|
9
|
+
a configured swap provider. The provider converts the payment to **BTC over
|
|
10
|
+
Lightning**, which settles into the merchant's connected wallet. Available
|
|
11
|
+
assets and networks depend on the provider; swaps are optional.
|
|
12
|
+
|
|
13
|
+
Pair this browser package with an OpenReceive server integration. Your server
|
|
14
|
+
authorizes the order, sets the amount, configures swaps, and verifies
|
|
15
|
+
settlement; wallet and provider credentials stay on the server.
|
|
16
|
+
|
|
17
|
+
## Install
|
|
18
|
+
|
|
19
|
+
Use Node.js 22 or later for package tooling.
|
|
20
|
+
|
|
21
|
+
```sh
|
|
22
|
+
npm install @openreceive/browser
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Follow the [frontend checkout guide](https://github.com/openreceive/openreceive/blob/master/docs/guides/frontend-checkout.md)
|
|
26
|
+
to connect your UI to your server routes. Use the server-side payment
|
|
27
|
+
hook to fulfill orders; browser callbacks update the interface.
|
|
4
28
|
|
|
5
29
|
Part of [OpenReceive](https://openreceive.org). Start with the [Node quickstart](https://github.com/openreceive/openreceive/blob/master/docs/guides/quickstart-node.md); the full API is in the [API reference](https://github.com/openreceive/openreceive/blob/master/docs/guides/api-reference.md).
|
|
6
30
|
|
|
@@ -43,4 +67,4 @@ Content-Security-Policy has a strict `img-src`, allow `data:`.
|
|
|
43
67
|
- The wallet logos and pay tutorials are `data:image/webp` URIs in
|
|
44
68
|
`@openreceive/provider-data`; `/headless` re-exports
|
|
45
69
|
`loadPayTutorialImages` / `payTutorialImage` for the lazy tutorial chunk.
|
|
46
|
-
See [docs/guides/provider-registry.md](
|
|
70
|
+
See [docs/guides/provider-registry.md](https://github.com/OpenReceive/openreceive/blob/master/docs/guides/provider-registry.md#assets).
|