@getalby/bitcoin-connect - npm Package Compare versions

Comparing version 1.1.0 to 1.1.1

package.json

		{
		"name": "@getalby/bitcoin-connect",
		"version": "1.1.0",
		"version": "1.1.1",
		"description": "Web components to connect to a lightning wallet and power a website with WebLN",
		@@ -48,3 +48,3 @@ "type": "module",
		"dependencies": {
		"@getalby/sdk": "^2.2.3",
		"@getalby/sdk": "^2.4.0",
		"lit": "^2.2.4",
		@@ -51,0 +51,0 @@ "zustand": "^4.4.1"

README.md

		@@ -11,2 +11,4 @@ # Bitcoin Connect

		> 🚧WARNING🚧: this package is currently in Alpha. It's got awesome features, but is using new features of protocols such as WebLN and NWC which have not been finalized, and there may be breaking changes or bugs.

		### React Package
		@@ -25,3 +27,3 @@
		```
		<script src="https://cdn.jsdelivr.net/npm/@getalby/bitcoin-connect@1.0.0/dist/index.browser.js"></script>
		<script src="https://cdn.jsdelivr.net/npm/@getalby/bitcoin-connect@1.1.0/dist/index.browser.js"></script>
		```
		@@ -132,14 +134,19 @@
		### 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. It will use the desktop extension as the default connector if it exists.

		### Can I connect it to my mobile wallet?

		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.

		### Can a user connect any lightning wallet?

		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?

		Yes. Your connection is saved to localStorage
		@@ -152,2 +159,3 @@
		### What are the high level things I need to do to add this to my site?

		1. add the "Connect Wallet" button
		@@ -154,0 +162,0 @@ 2. wait for a connection event (using window.addEventListener) and then request to pay the invoice with window.webln

dist/components/connectors/ConnectorElement.d.ts.map