Skip to content

Commit

Permalink
[FAB-4284] - Fix SDK links
Browse files Browse the repository at this point in the history
incorporate JZ comments..
couple outdated links changed to accurate URL
[ci-skip]

Change-Id: I2530d9243d330360f11efc8cd4e60b98135b6082
Signed-off-by: Nick Gaski <ngaski@us.ibm.com>
  • Loading branch information
nickgaski committed Jun 8, 2017
1 parent d25b994 commit 4c19614
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 36 deletions.
41 changes: 9 additions & 32 deletions docs/source/Setup/NodeSDK-setup.rst
Original file line number Diff line number Diff line change
@@ -1,39 +1,16 @@
Hyperledger Fabric Client (HFC) SDK for Node.js
Hyperledger Fabric SDK for Node.js
-----------------------------------------------

The Hyperledger Fabric Client (HFC) SDK provides a powerful and easy to
use API to interact with a Hyperledger Fabric blockchain.
The Hyperledger Fabric SDK for Node.js provides a powerful and easy-to-use API
to interact with a Hyperledger Fabric blockchain.

This document assumes that you already have set up a Node.js development
environment. If not, go
`here <https://nodejs.org/en/download/package-manager/>`__ to download
and install Node.js for your OS. You'll also want the latest version of
``npm`` installed. For that, execute ``sudo npm install npm -g`` to get
the latest version.
Refer to the `Hyperledger Fabric SDK for Node.js <https://github.com/hyperledger/fabric-sdk-node>__`
library for prerequisites and instructions on setting up your local environment.
The library contains scripts and sample applications to facilitate development and
run end-to-end testing.

Installing the hfc module
~~~~~~~~~~~~~~~~~~~~~~~~~

We publish the ``hfc`` node module to ``npm``. To install ``hfc`` from
npm simply execute the following command:

::

npm install -g hfc

See `Hyperledger fabric Node.js client
SDK <http://fabric-sdk-node.readthedocs.io/en/latest/node-sdk-guide>`__
for more information.

Hyperledger fabric network
--------------------------

First, you'll want to have a running peer node and member services. The
instructions for setting up a network are `here <Network-setup.md>`__.
You may also use the
`Fabric-starter-kit <../starter/fabric-starter-kit.md>`__ that provides
the network.
See the `Hyperledger Fabric SDK for Node.js <https://fabric-sdk-node.github.io/>`__
documentation for API reference on classes and methods.

.. Licensed under Creative Commons Attribution 4.0 International License
https://creativecommons.org/licenses/by/4.0/
8 changes: 4 additions & 4 deletions test/tools/PTE/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@

# Performance Traffic Engine - PTE

The Performance Traffic Engine (PTE) uses [Hyperledger Fabric Client (HFC) Node SDK](http://hyperledger-fabric.readthedocs.io/en/latest/nodesdk.html) to interact with a [Hyperledger Fabric](http://hyperledger-fabric.readthedocs.io/en/latest/) network.
The Performance Traffic Engine (PTE) uses [Hyperledger Fabric Client (HFC) Node SDK](https://fabric-sdk-node.github.io/index.html)
to interact with a [Hyperledger Fabric](http://hyperledger-fabric.readthedocs.io/en/latest/) network.

## Table Of Contents:
- [Prerequisites](#prerequisites)
Expand All @@ -28,7 +29,7 @@ The Performance Traffic Engine (PTE) uses [Hyperledger Fabric Client (HFC) Node
- PTE commit level: `latest`

### Code Base for v1.0.0-alpha
For v1.0.0-alpha support, use v1performance commit level `aa73747ccf5f511fbcd10a962dd1e588bde1a8b0`.
For v1.0.0-alpha support, use v1performance commit level `aa73747ccf5f511fbcd10a962dd1e588bde1a8b0`.
Below is the v1.0.0-alpha commit levels.

- Fabric commit level: `fa3d88cde177750804c7175ae000e0923199735c`
Expand Down Expand Up @@ -258,7 +259,7 @@ Although PTE's primary use case is to drive transactions into a Fabric network,
```
"transMode": "Simple",
"transType": "instantiate",
"invokeType": "Move",
"invokeType": "Move",
```
and set channelOpt name to the channel name:
```
Expand Down Expand Up @@ -516,4 +517,3 @@ The service credentials contain the information of the network and are stored in
---
<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.

0 comments on commit 4c19614

Please sign in to comment.