diff --git a/README.md b/README.md index dc552fc81..4dd122bb5 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,8 @@ [![Deploy to Bluemix](https://bluemix.net/deploy/button.png)](https://bluemix.net/deploy?repository=https://github.com/ibm-blockchain/marbles.git) -#Application Background +# Application Background + Hold on to your hats everyone, this application is going to demonstrate transferring marbles between two users leveraging IBM Blockchain. We are going to do this in Node.js and a bit of GoLang. The backend of this application will be the GoLang code running in our blockchain network. @@ -25,20 +26,22 @@ This allow us to use dot notation to call our GoLang functions (such as `chainco Start the tutorials below to have your own marbles blockchain demo! -## Doc Links -- Tutorial for Marbles [Part 1](./tutorial_part1.md) (start here!) +## Tutorial / Documentation +- Looking for chaincode documentation? Check out the [learn chaincode](https://github.com/IBM-Blockchain/learn-chaincode) repo - **start here!** +- Tutorial for Marbles [Part 1](./tutorial_part1.md) - Tutorial for Marbles [Part 2](./tutorial_part2.md) -- Documentation for IBM Blockchain [JS SDK](https://github.com/IBM-Blockchain/ibm-blockchain-js) -- Looking for chaincode documentation? The best I have is in the Part 1 and Part 2 tutorials above. +- Documentation for IBM Blockchain [JS SDK](https://github.com/IBM-Blockchain/ibm-blockchain-js) (our REST based SDK) *** ## Projects Contents -See tutorial above to get started. +If you **run marbles on local host** you will have these two urls: 1. Marbles Part 1 - [http://localhost:3000/p1](http://localhost:3000/p1) 1. Marbles Part 2 - [http://localhost:3000/p2](http://localhost:3000/p2) + + ## Privacy Notice This web application includes code to track deployments to [IBM Bluemix](https://www.bluemix.net/) and other Cloud Foundry platforms. The following information is sent to a [Deployment Tracker](https://github.com/cloudant-labs/deployment-tracker) service on each deployment: @@ -48,8 +51,6 @@ This web application includes code to track deployments to [IBM Bluemix](https:/ * Application Version (`application_version`) * Application URIs (`application_uris`) -This data is collected from the `VCAP_APPLICATION` environment variable in IBM Bluemix and other Cloud Foundry platforms. This data is used by IBM to track metrics around deployments of sample applications to IBM Bluemix to measure the usefulness of our examples, so that we can continuously improve the content we offer to you. Only deployments of sample applications that include code to ping the Deployment Tracker service will be tracked. - -### Disabling Deployment Tracking +This data is used by IBM to track metrics around deployments of sample applications to IBM Bluemix to measure the usefulness of our examples, so that we can continuously improve the content we offer to you. Only deployments of sample applications that include code to ping the Deployment Tracker service will be tracked. -Deployment tracking can be disabled by deleting the 'Deployment Tracking' section of app.js. \ No newline at end of file +**Deployment tracking can be disabled by deleting the 'Deployment Tracking' section in app.js.** \ No newline at end of file