update readme and bump version

threefoldtech · Jan 22, 2021 · 38c79af · 38c79af
1 parent b464999
commit 38c79af
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/api-client/package.json b/api-client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "tfgrid-api-client",
-  "version": "0.0.1-beta.2",
+  "version": "0.0.1-beta.4",
   "description": "API client for the TF Grid",
   "main": "index.js",
   "scripts": {
@@ -9,7 +9,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@polkadot/api": "^3.4.1",
+    "@polkadot/api": "^3.5.1",
     "bip39": "^3.0.3",
     "bn.js": "^5.1.3"
   },

diff --git a/api-client/readme.md b/api-client/readme.md
@@ -18,13 +18,15 @@ Available methods:
 inits the client and returns a promise
 
 ```js
+const Client = require('tfgrid-api-client')
+
 const url = "urlToWebsocket"
 const mnemonic = "some words"
 
-const cli = new Client(url, mnemonic)
+const client = new Client(url, mnemonic)
 
 try {
-  await cli.init()
+  await client.init()
 } catch (err) {
   return err
 }