From c9dada6d2566980b5f3a355f045fcd5ddfd58409 Mon Sep 17 00:00:00 2001 From: Roland <33993199+rolznz@users.noreply.github.com> Date: Fri, 18 Aug 2023 14:15:51 +0700 Subject: [PATCH 1/3] doc: add FAQ section to README --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d42d3da..23b8d94 100644 --- a/README.md +++ b/README.md @@ -131,7 +131,7 @@ Open [dev](dev/README.md) `yarn test` -## Need help? +# Need help? We are happy to help, please contact us or create an issue. @@ -141,6 +141,19 @@ We are happy to help, please contact us or create an issue. - [bitcoin.design](https://bitcoin.design/) Discord community (find us on the #alby channel) - Read the [Alby developer guide](https://guides.getalby.com/overall-guide/alby-for-developers/getting-started) to better understand how Alby packages and APIs can be used to power your app. +## FAQ +- Does it work for any user with any lightning wallet? + +It will only work for the connectors that are shown in the modal. Feel free to contribute to add a new connector. + +- Does it "remember" the user if they leave the page or close the browser? + +Yes. Your connection is saved to localStorage + +- Is this safe? + +You should have a certain level of trust on the website you decide to connect your wallet with, and that they ensure there is no malicious third-party scripts which would intend to read the wallet connection configuration, either from memory or storage. Connectors with budget controls or confirmation dialogs (Alby extension or NWC) are recommend so you have full control over your connection. + # 🔥 Lit This project is powered by Lit. From 868026af288170dacc934ea869b39b971b7c4a06 Mon Sep 17 00:00:00 2001 From: Roland <33993199+rolznz@users.noreply.github.com> Date: Fri, 18 Aug 2023 14:22:18 +0700 Subject: [PATCH 2/3] doc: add more FAQ --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 23b8d94..09d8368 100644 --- a/README.md +++ b/README.md @@ -142,6 +142,18 @@ We are happy to help, please contact us or create an issue. - Read the [Alby developer guide](https://guides.getalby.com/overall-guide/alby-for-developers/getting-started) to better understand how Alby packages and APIs can be used to power your app. ## FAQ +- Does this work on mobile browsers and mobile PWAs, or desktop browsers without a WebLN extension? + +Yes! that's the main benefit. + +- Does it work with a desktop extension enabled? + +Yes. But it will use the desktop extension as the default connector if it exists. + +- Can I connect it to my mobile wallet? + +Probably not. The connection to your lightning node / wallet needs to be asynchronous so that you can use Bitcoin Connect natively on mobile websites or PWAs. + - Does it work for any user with any lightning wallet? It will only work for the connectors that are shown in the modal. Feel free to contribute to add a new connector. @@ -154,6 +166,13 @@ Yes. Your connection is saved to localStorage You should have a certain level of trust on the website you decide to connect your wallet with, and that they ensure there is no malicious third-party scripts which would intend to read the wallet connection configuration, either from memory or storage. Connectors with budget controls or confirmation dialogs (Alby extension or NWC) are recommend so you have full control over your connection. +- What are the high level things I need to do to add this to my site? + +1. add the "Connect Wallet" button +2. wait for a connection event (using window.addEventListener) and then request to pay the invoice with window.webln + + + # 🔥 Lit This project is powered by Lit. From 6431c4ec502e00deb0471c5cf83cdda87323ecbe Mon Sep 17 00:00:00 2001 From: Moritz Kaminski Date: Fri, 18 Aug 2023 09:37:56 +0200 Subject: [PATCH 3/3] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 09d8368..4bd7cc6 100644 --- a/README.md +++ b/README.md @@ -148,15 +148,15 @@ Yes! that's the main benefit. - Does it work with a desktop extension enabled? -Yes. But it will use the desktop extension as the default connector if it exists. +Yes. It will use the desktop extension as the default connector if it exists. - Can I connect it to my mobile wallet? -Probably not. The connection to your lightning node / wallet needs to be asynchronous so that you can use Bitcoin Connect natively on mobile websites or PWAs. +That depends. The connection to your lightning node / wallet needs to be asynchronous so that you can use Bitcoin Connect natively on mobile websites or PWAs. -- Does it work for any user with any lightning wallet? +- Can a user connect any lightning wallet? -It will only work for the connectors that are shown in the modal. Feel free to contribute to add a new connector. +It will only work for the connectors that are shown in the modal. Some of these connectors (e.g. the Alby Browser Extension) allow to connect multiple wallets themselves. Feel free to contribute to add a new connector. - Does it "remember" the user if they leave the page or close the browser?