Skip to content

Commit

Permalink
[FABN-1173] update readme files
Browse files Browse the repository at this point in the history
- Add readme to protos package
- Update other readme files to include existence of other packages

Change-Id: Iaaa19cca2bed25f4ca73b69bbad9511447c1dbbe
Signed-off-by: [email protected] <[email protected]>
  • Loading branch information
nklincoln committed Mar 8, 2019
1 parent f67f186 commit 3ba4574
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 4 deletions.
6 changes: 5 additions & 1 deletion fabric-ca-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@ SDK for writing node.js applications to interact with [Hyperledger Fabric CA](ht

This package encapsulates the APIs to interact with the Fabric CA to manage user certificates lifecycle such as register, enroll, renew and revoke.

A separate package is provided, `fabric-client`, to interact with Peers and Orderers to install and instantiate chaincodes, send transactions and perform queries.
Additional packages are also provided:
1. `fabric-client`, supporting fine grain interactions with Peers and Orders of the Fabric network to install and instantiate chaincodes, send transaction invocations and perform chaincode queries.
2. `fabric-network`, to provide APIs to connect to a Fabric network, submit transactions and perform queries against the ledger.
3. `fabric-common`, encapsulates the common code used by all fabric-sdk-node packages.
4. `fabric-protos`, encapsulates the Protocol Buffer files and generated JavaScript classes for Hyperledger Fabric

For application developer documentations, please visit [https://fabric-sdk-node.github.io/](https://fabric-sdk-node.github.io/)

Expand Down
6 changes: 5 additions & 1 deletion fabric-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@ SDK for writing node.js applications to interact with [Hyperledger Fabric](http:

This package encapsulates the APIs to interact with Peers and Orderers of the Fabric network to install and instantiate chaincodes, send transaction invocations and perform chaincode queries.

A separate package is provided, `fabric-ca-client`, to interact with the fabric-ca to manage user certificates.
Additional packages are also provided:
1. `fabric-ca-client`, to interact with the fabric-ca to manage user certificates.
2. `fabric-network`, to provide APIs to connect to a Fabric network, submit transactions and perform queries against the ledger.
3. `fabric-common`, encapsulates the common code used by all fabric-sdk-node packages.
4. `fabric-protos`, encapsulates the Protocol Buffer files and generated JavaScript classes for Hyperledger Fabric

For application developer documentations, please visit [https://fabric-sdk-node.github.io/](https://fabric-sdk-node.github.io/)

Expand Down
6 changes: 5 additions & 1 deletion fabric-common/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@

SDK for writing node.js applications to interact with [Hyperledger Fabric](http://hyperledger-fabric.readthedocs.io/en/latest/).

This package encapsulates the common code used by the `fabric-ca-client`, `fabric-client` packages.
This package encapsulates the common code used by the `fabric-ca-client`, `fabric-client` packages. Additional packages are also provided:
1. `fabric-client`, supporting fine grain interactions with Peers and Orders of the Fabric network to install and instantiate chaincodes, send transaction invocations and perform chaincode queries.
2. `fabric-ca-client`, to interact with the fabric-ca to manage user certificates.
3. `fabric-network`, to provide APIs to connect to a Fabric network, submit transactions and perform queries against the ledger.
5. `fabric-protos`, encapsulates the Protocol Buffer files and generated JavaScript classes for Hyperledger Fabric

For application developer documentations, please visit [https://fabric-sdk-node.github.io/](https://fabric-sdk-node.github.io/)

Expand Down
4 changes: 3 additions & 1 deletion fabric-network/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ SDK for writing node.js applications to interact with [Hyperledger Fabric](http:

This package encapsulates the APIs to connect to a Fabric network, submit transactions and perform queries against the ledger.

Two separate packages are also provided:
Additional packages are also provided:
1. `fabric-client`, supporting fine grain interactions with Peers and Orders of the Fabric network to install and instantiate chaincodes, send transaction invocations and perform chaincode queries.
2. `fabric-ca-client`, to interact with the fabric-ca to manage user certificates.
3. `fabric-common`, encapsulates the common code used by all fabric-sdk-node packages.
4. `fabric-protos`, encapsulates the Protocol Buffer files and generated JavaScript classes for Hyperledger Fabric

For application developer documentations, please visit [https://fabric-sdk-node.github.io/](https://fabric-sdk-node.github.io/)

Expand Down
16 changes: 16 additions & 0 deletions fabric-protos/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## Hyperledger Fabric Protos for Node.js

SDK for writing node.js applications to interact with [Hyperledger Fabric](http://hyperledger-fabric.readthedocs.io/en/latest/).

This package encapsulates the Protocol Buffer files and generated JavaScript classes for Hyperledger Fabric.

Additional packages are also provided:
1. `fabric-client`, supporting fine grain interactions with Peers and Orders of the Fabric network to install and instantiate chaincodes, send transaction invocations and perform chaincode queries.
2. `fabric-ca-client`, to interact with the fabric-ca to manage user certificates.
3. `fabric-network`, to provide APIs to connect to a Fabric network, submit transactions and perform queries against the ledger.
4. `fabric-common`, encapsulates the common code used by all fabric-sdk-node packages.

For application developer documentations, please visit [https://fabric-sdk-node.github.io/](https://fabric-sdk-node.github.io/)

<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 3ba4574

Please sign in to comment.