Merge branch 'master' into 5.x

timoxley · timoxley · commit 672420b8bf6c · 2021-02-10T13:37:24.000-05:00
* master:
  Update chromedriver to Chrome 88
  Update README.md
  Update node-example-subscribe.js
  Update node-example-produce.js
  Update web-example-produce.html
diff --git a/README.md b/README.md
@@ -28,6 +28,8 @@ The client is available on [npm](https://www.npmjs.com/package/streamr-client) a
 
 `npm install streamr-client`
 
+Node v14 or higher is recommended if you intend to use the client in a Node environment. For example, inside a script.
+
 ## Usage
 
 Here are some quick examples. More detailed examples for the browser and node.js can be found [here](https://github.com/streamr-dev/streamr-client/tree/master/examples).
diff --git a/examples/node/node-example-produce.js b/examples/node/node-example-produce.js
@@ -3,9 +3,7 @@ const StreamrClient = require('streamr-client')
 // Create the client and supply either an API key or an Ethereum private key to authenticate
 const client = new StreamrClient({
     auth: {
-        apiKey: 'YOUR-API-KEY',
-        // Or to cryptographically authenticate with Ethereum and enable data signing:
-        // privateKey: 'ETHEREUM-PRIVATE-KEY',
+        privateKey: 'ETHEREUM-PRIVATE-KEY',
     },
 })
 
diff --git a/examples/node/node-example-subscribe.js b/examples/node/node-example-subscribe.js
@@ -3,9 +3,7 @@ const StreamrClient = require('streamr-client')
 // Create the client and supply either an API key or an Ethereum private key to authenticate
 const client = new StreamrClient({
     auth: {
-        apiKey: 'YOUR-API-KEY',
-        // Or to cryptographically authenticate with Ethereum and enable data signing:
-        // privateKey: 'ETHEREUM-PRIVATE-KEY',
+        privateKey: 'ETHEREUM-PRIVATE-KEY',
     },
 })
 
diff --git a/examples/web/web-example-produce.html b/examples/web/web-example-produce.html
@@ -2,6 +2,7 @@
 <head>
     <!-- For debug messages, include debug.js and set localStorage.debug = 'StreamrClient'. See from https://github.com/visionmedia/debug -->
     <script src="../../dist/streamr-client.web.js"></script>
+    <!-- Or use unpkg, e.g. https://unpkg.com/browse/streamr-client@4.1.6/dist/streamr-client.web.js -->
 
     <script>
         const log = (msg) => {
@@ -12,12 +13,11 @@
 
         // register and get from https://streamr.network/signup
         const STREAM_ID = 'MY-STREAM-ID'
-        const API_KEY = 'MY-API-KEY'
 
-            // Create the client and give the API key to use by default
+        // Create the client and give the API key to use by default
         const client = new StreamrClient({
             auth: {
-                apiKey: API_KEY,
+                privateKey: 'your-private-key',
             }
         })
 
diff --git a/package-lock.json b/package-lock.json
