From 65db7ec61c9383ec27abe2a598188ff83e083242 Mon Sep 17 00:00:00 2001 From: Divyank Katira Date: Fri, 7 Apr 2017 14:23:55 -0400 Subject: [PATCH] Update README Change-Id: I656081cd8a3745ef8b978a25146752cc3d2d5825 Signed-off-by: Divyank Katira --- README.md | 60 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 31 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 4e10d2d251..c02b2877dd 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,31 @@ -# Hyperledger Fabric Client SDK for Go -[![Go Report Card](https://goreportcard.com/badge/github.com/hyperledger/fabric-sdk-go)](https://goreportcard.com/report/github.com/hyperledger/fabric-sdk-go) -[![GoDoc](https://godoc.org/github.com/hyperledger/fabric-sdk-go?status.svg)](https://godoc.org/github.com/hyperledger/fabric-sdk-go) - -The Hyperledger Fabric Client SDK makes it easy to use APIs to interact with a Hyperledger Fabric blockchain. - -This SDK is targeted both towards the external access to a Hyperledger Fabric blockchain using a Go application, as well as being targeted at the internal library in a peer to access API functions on other parts of the network. - -**NOTE:** In an effort to make the codebase more modular, there will be interface changes over the course of the next week. - -This is a **read-only mirror** of the formal [Gerrit](https://gerrit.hyperledger.org/r/#/admin/projects/fabric-sdk-go) -repository, where active development is ongoing. Issue tracking is handled in [Jira](https://jira.hyperledger.org/secure/RapidBoard.jspa?projectKey=FAB&rapidView=7&view=planning) - -## Build and Test - -This project must be cloned into `$GOPATH/src/github.com/hyperledger`. Package names have been chosen to match the Hyperledger project. - -Execute `go test` from the fabric-client and fabric-ca-client to build the library and run the basic headless tests. - -Execute `go test` in the `test/integration` to run end-to-end tests. This requires you to have: -- A working fabric, and fabric-ca set up. It is recommended that you use the docker-compose file provided in `test/fixtures`. Refer to the Hyperledger Fabric [documentation](https://github.com/hyperledger/fabric) on how to do this. -- Customized settings in the `test/fixtures/config/config_test.yaml` in case your Hyperledger Fabric network is not running on `localhost` or is using different ports. - - -## Compatibility - -This client was last tested and found to be compatible with the following Hyperledger Fabric commit levels: -- fabric: v1.0.0-alpha -- fabric-ca: v1.0.0-alpha +# Hyperledger Fabric Client SDK for Go +[![Build Status](https://jenkins.hyperledger.org/buildStatus/icon?job=fabric-sdk-go-tests-verify-x86_64)](https://jenkins.hyperledger.org/job/fabric-sdk-go-tests-verify-x86_64) +[![Go Report Card](https://goreportcard.com/badge/github.com/hyperledger/fabric-sdk-go)](https://goreportcard.com/report/github.com/hyperledger/fabric-sdk-go) +[![GoDoc](https://godoc.org/github.com/hyperledger/fabric-sdk-go?status.svg)](https://godoc.org/github.com/hyperledger/fabric-sdk-go) + +The Hyperledger Fabric Client SDK makes it easy to use APIs to interact with a Hyperledger Fabric blockchain. + +This SDK is targeted both towards the external access to a Hyperledger Fabric blockchain using a Go application, as well as being targeted at the internal library in a peer to access API functions on other parts of the network. + +**NOTE:** In an effort to make the codebase more modular, there will be interface changes over the course of the next week. + +This is a **read-only mirror** of the formal [Gerrit](https://gerrit.hyperledger.org/r/#/admin/projects/fabric-sdk-go) +repository, where active development is ongoing. Issue tracking is handled in [Jira](https://jira.hyperledger.org/secure/RapidBoard.jspa?projectKey=FAB&rapidView=7&view=planning) + +## Build and Test + +This project must be cloned into `$GOPATH/src/github.com/hyperledger`. Package names have been chosen to match the Hyperledger project. + +Execute `go test` from the fabric-client and fabric-ca-client to build the library and run the basic headless tests. + +Execute `go test` in the `test/integration` to run end-to-end tests. This requires you to have: +- A working fabric, and fabric-ca set up. It is recommended that you use the docker-compose file provided in `test/fixtures`. Refer to the Hyperledger Fabric [documentation](https://github.com/hyperledger/fabric) on how to do this. +- Customized settings in the `test/fixtures/config/config_test.yaml` in case your Hyperledger Fabric network is not running on `localhost` or is using different ports. + + +## Compatibility + +This client was last tested and found to be compatible with the following Hyperledger Fabric commit levels: +- fabric: v1.0.0-alpha +- fabric-ca: v1.0.0-alpha +