ibm-blockchain-js - npm Package Compare versions

Comparing version 1.2.5 to 1.2.6

package.json

 {
   "name": "ibm-blockchain-js",
-  "version": "1.2.5",
+  "version": "1.2.6",
   "description": "A library for easily interacting with IBM Blockchain.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

 *Are you looking for the Marbles app demo?  That’s not here, head to the [marbles example](https://github.com/IBM-Blockchain/marbles)* 
 
 # ibm-blockchain-js
-This is a Node.js library for easier interaction IBM Blockchain chaincode. 
-All documentation is on this page.
+This is a Node.js library for REST based interaction with [Hyperledger](https://github.com/hyperledger/fabric) [chaincode](https://github.com/hyperledger/fabric/blob/master/docs/FAQ/chaincode_FAQ.md/). 
+All `ibm-blockchain-js` documentation is on this page.
 
+*7/22 Update! there is a new gRPC based SDK called [HFC](https://github.com/hyperledger/fabric/tree/master/sdk/node). I will continue to maintain this SDK for as long as REST exists.*
+
 Table Of Contents:
@@ -58,4 +60,4 @@
 				"api_host": "xxx.xxx.xxx.xxx",
-				"api_port": "xxxxx",
-				"api_port_tls": "xxx",
+				"api_port": xxx,
+				"api_port_tls": xxx,
 				"id": "xxxxxx-xxxx-xxx-xxx-xxxxxxxxxxxx_vpx"
@@ -184,3 +186,3 @@ }],
 
-1. ibc.network(options.network.peers, options.network.options) *check out other options in [ibc.network()](#ibcnetworkarraypeers-optionsk)*
+1. ibc.network(options.network.peers, options.network.options) *check out other options in [ibc.network()](#ibcnetwork)*
 1. ibc.register(...) 
@@ -193,5 +195,5 @@ - It will register the first peer with the first enrollId, the 2nd peer against the 2nd enrollId and so on.
 
-Options
-- **maxRetry** = integer - number of times to retry this call before giving up.
-- [more] - same options as the function ibc.network(), [see network()](#ibcnetworkarraypeers-optionsk) for details 
+Options: 
+- **maxRetry** = integer - number of times to retry `ibc.register()` before giving up
+- [more] - same options as the function [ibc.network()](#ibcnetwork), click for details 
 
@@ -205,4 +207,4 @@ Ex:
 				"api_host": "xxx.xxx.xxx.xxx",
-				"api_port": "xxxxx",
-				"api_port_tls": "xxx",
+				"api_port": xxx,
+				"api_port_tls": xxx,
 				"id": "xxxxxx-xxxx-xxx-xxx-xxxxxxxxxxxx_vpx"
@@ -255,6 +257,9 @@ }],
 
-### ibc.network(arrayPeers, [options])
+### <a name="ibcnetwork"></a>ibc.network(arrayPeers, [options])
 Set the information about the peers in the network.
 This should be an array of peer objects. 
-The optional options parameter should be an object with the field `quiet` and/or `timeout`.
+The options parameter is optional.
+Each field in `options` is also optional.
+
+Options: 
 - **quiet** = boolean - when true will print out only minimal HTTP debug information. Defaults `true`.
@@ -270,4 +275,4 @@ - **timeout** = integer - time in ms to wait for a http response. Defaults `60000`.
 			"api_host": "xxx.xxx.xxx.xxx",               //ip or hostname of api for this peer
-			"api_port": "xxxxx",                         //port for api, non tls
-			"api_port_tls": "xxx",                       //port for api with tls.
+			"api_port": xxx,                             //port for api, non tls (integer)
+			"api_port_tls": xxx,                         //port for api with tls. (integer)
 			"id": "xxxxxx-xxxx-xxx-xxx-xxxxxxxxxxxx_vpx" //unique id of peer (string)
@@ -283,3 +288,3 @@ }
 You can ommit the field `api_port_tls` if your network does not support tls. 
-Make sure the `options.tls` is `true`.
+Make sure the `options.tls` is `false`.
 
@@ -517,5 +522,5 @@ ### ibc.save(path [callback])
 	{
-		name: "input error",
-		code: 400,
-		details: {msg: "did not provide git_url"}
+		name: "input error",                       //short name of error
+		code: 400,                                 //http error status code, integer
+		details: {msg: "did not provide git_url"}  //description of error, obj of unknown makeup
 	};
@@ -525,3 +530,3 @@ ```
 ### <a name="ccsf"></a>Chaincode Summary File
-This file is used internally. 
+This file is used internally when debugging. 
 It is created in ibc.load_chaincode() and updated with chaincode.deploy(). 
@@ -545,3 +550,3 @@ A copy can be saved elsewhere with ibc.save(path).
 			"api_host": "xxx.xxx.xxx.xxx",
-			"api_port": "xxx",
+			"api_port": xxx,
 			"id": "xxxxx_vp1",
@@ -548,0 +553,0 @@ "tls": false,

No alert changes

Improved metrics

Total package byte prevSize

92505

increased by0.54%

Number of lines in readme file

584

increased by0.86%

No dependency changes