@electrum-cash/network 3.2.0-r1 → 3.3.0-development.6103536979

package/README.md

@@ -15,7 +15,7 @@ Install the library with NPM:
 
 ## Usage
 
-### Load library
+### Usage with NodeJS
 
 Before you can use the library you need to include it in your project.
 
@@ -33,6 +33,15 @@ If you want to use **multiple servers**, load the `ElectrumCluster` module:
 const { ElectrumCluster } = require('electrum-cash');
 ```
 
+### Usage on Web
+
+To use the library on the web, use the ESM import syntax and include the `ElectrumTransport` import:
+
+```js
+// Load the electrum library.
+import { ElectrumClient, ElectrumTransport } from 'electrum-cash';
+```
+
 ### Connect to servers
 
 After you have loaded the appropriate module you need to initialize the module by configuring your **application identifier** and **protocol version**.
@@ -46,6 +55,15 @@ const electrum = new ElectrumClient('Electrum client example', '1.4.1', 'bch.ima
 await electrum.connect();
 ```
 
+To connect to an electrum server from a web browser, use the `ElectrumTransport` import to use the WSS `port` and `scheme`:
+
+```js
+const electrum = new ElectrumClient(
+	'Electrum client example', '1.4.1', 'bch.imaginary.cash',
+	ElectrumTransport.WSS.Port, ElectrumTransport.WSS.Scheme
+);
+```
+
 If you want to use multiple servers, initialize an `ElectrumCluster` and add some servers:
 
 *For more information on various cluster configurations, read the [cluster documentation](https://read.cash/@JonathanSilverblood/electrum-cash-strategic-use-of-clusters-83743111).*
@@ -65,6 +83,7 @@ electrum.addServer('electrum.imaginary.cash');
 await electrum.ready();
 ```
 
+
 ### Request information
 
 Once your `ElectrumClient` or `ElectrumCluster` is connected and ready, you can call methods: