carauction-network - npm Package Compare versions

Comparing version 0.0.4-20170315181444 to 0.0.4-20170316133210

package.json

 {
   "name": "carauction-network",
-  "version": "0.0.4-20170315181444",
+  "version": "0.0.4-20170316133210",
   "description": "Car Auction Business Network",
@@ -5,0 +5,0 @@ "scripts": {

README.md

@@ -21,8 +21,8 @@ # Fabric Composer Car Auction Demo
 
-> ### Developer Unit Testing
+### Developer Unit Testing
 
-> Note that if you `git clone` the [repository](https://github.com/fabric-composer/sample-networks) for the Business Network you can run a unit tests for the logic in the business network using the Fabric Composer embedded runtime which simulates a Hyperledger Fabric using a pure Javascript runtime. Simply run:
+ > Note that if you `git clone` the [repository](https://github.com/fabric-composer/sample-networks) for the Business Network you can run a unit tests for the logic in the business network using the Fabric Composer embedded runtime which simulates a Hyperledger Fabric using a pure Javascript runtime. Simply run:
 
-> ```
-cd packages/CarAuction2-Network
+ ```
+cd packages/carAuction-network
 npm install
@@ -32,12 +32,12 @@ npm test
 
-> The unit test [here](https://github.com/fabric-composer/sample-networks/blob/master/packages/carauction-network/test/CarAuction.js) simulates an entire auction and checks that the business logic functions as expected.
+The unit test [here](https://github.com/fabric-composer/sample-networks/blob/master/packages/carauction-network/test/CarAuction.js) simulates an entire auction and checks that the business logic functions as expected.
 
 ## Connect to Composer
 
-You can connect to Composer [here](http://composer-playground.mybluemix.net). If you have used Composer before you may need to clear your cached browser data (or use private/incognito mode).
+You can connect to Composer [here](http://composer-playground.mybluemix.net). If you have used Composer before you may need to clear your cached browser data.
 
+> Playground currently only supports the web profile.
+
 After you are connected make sure that Composer is communicating with the **'hyperledger'** connection profile by clicking the network dropdown at the top-right of the menu. The web profile allows you to test in isolation using a simulated hyperledger, storing the ledger in browser local storage. The 'bluemix' connection profile is to a version of Fabric Composer deployed to bluemix.
 
-> Note: Playground currently only supports the web profile.
-
 ## Setting Up the Demo
@@ -49,3 +49,3 @@
 
-Click on the Participants tab, click on the `org.acme.vehicle.auction.User` participant registry, and then click on the `+` icon to create a new instance of a user.
+Switch to the Test tab, then click on the `User` participant registry, then click on the `Create Participant` button to create a new instance of a user.
 
@@ -66,7 +66,8 @@ The JSON representation of the User should be:
 
-> Playground does not yet support this
-> You now need to issue an identity card for this participant. Click the green ID card icon to the right of your participant. Enter an user id, for example `daniel.selman` and select the "Identity can be used to issue other identities?" checkbox so that this user has permission to invite other users into the business network.
+> Playground does not yet support issuing and managing Fabric identifies.
 
-> You can switch between identities using the menu option at the top right of the screen.
+You now need to issue an identity card for this participant. Click the green ID card icon to the right of your participant. Enter an user id, for example `daniel.selman` and select the "Identity can be used to issue other identities?" checkbox so that this user has permission to invite other users into the business network.
 
+You can switch between identities using the menu option at the top right of the screen.
+
 ### Create Assets
@@ -80,3 +81,3 @@
 
-Click on the Assets tab, click on the `org.acme.vehicle.auction.Vehicle` asset registry, and then click on the `+` icon to create a new instance of a vehicle that can be auctioned.
+Click on the `Vehicle` asset registry, and then click on the `Create Asset` button to create a new instance of a vehicle that can be auctioned.
 
@@ -99,3 +100,3 @@ The JSON representation of the Vehicle should be:
 
-Click on the Assets tab, click on the `org.acme.vehicle.auction.VehicleListing` asset registry, and then click on the `+` icon to create a new instance of a vehicle listing.
+Click on the click on the `VehicleListing` asset registry, and then click on the `Create Asset` icon to create a new instance of a vehicle listing.
 
@@ -119,2 +120,4 @@ The JSON representation of the `VehicleListing` should be:
 
+> Playground does not yet support inviting participants via a URL
+
 An auction with one person is not much fun, so you need to either invite people to use Composer to create their own participants and identities, or you can do it for them. To make it easy for participants that you've created to join the business network (auction) when an identity is issued a personalised URL is generated that you can send to allow participants to join the business network in a single click.
@@ -128,3 +131,3 @@
 
-Click on the Transactions tab and then click on the `+` icon to submit a new transaction for processing by the business network.
+Click on the Submit Transaction button to submit a new transaction for processing by the business network.
 
@@ -150,3 +153,3 @@ The JSON payload should be:
 
-Click on the Transactions tab and then click on the `+` icon to submit a new transaction for processing by the business network.
+Click on the Submit Transaction button to submit a new transaction for processing by the business network.
 
@@ -167,7 +170,7 @@ The JSON payload should be:
 
-To see if the Vehicle was sold you need to click on the Assets tab, click on the `org.acme.vehicle.auction.Vehicle` asset registry and then check the owner of CAR_001. If the reserve price was met you should see that the owner of the vehicle has been modified.
+To see if the Vehicle was sold you need to click on the `Vehicle` asset registry and then check the owner of CAR_001. If the reserve price was met you should see that the owner of the vehicle has been modified.
 
 If you check the state of the VehicleListing is should either be `SOLD` or `RESERVE_NOT_MET`.
 
-If you click on the Participants tab you can check the balance of each User. You should see that the balance of the buyer has been debited by the amount they bid, whilst the balance of the seller has been credited.
+If you click on the 'User' asset registry you can check the balance of each User. You should see that the balance of the buyer has been debited by the amount they bid, whilst the balance of the seller has been credited.
 
@@ -177,7 +180,8 @@ ## View the Blockchain
 > Not yet supported in Playground
-> You can inspect the blocks and transaction created by Hyperledger during the course of the auction using the Hyperledger Explorer. Details TBD.
 
+You can inspect the blocks and transaction created by Hyperledger during the course of the auction using the Hyperledger Explorer. Details TBD.
+
 ## Reset the Auction
 
-To reset the auction you need to edit the VehicleListing to reset its state to `FOR_SALE`. Simply click on the Assets tab, navigate to the VehicleListing registry and then click the pencil icon to update the VehicleListing back to its original state.
+To reset the auction you need to edit the VehicleListing to reset its state to `FOR_SALE`. Simply click on the `VehicleListing` registry and then click the pencil icon to update the VehicleListing back to its original state.
 
@@ -184,0 +188,0 @@ The JSON representation of the `VehicleListing` should be:

No alert changes

Improved metrics

Number of lines in readme file

189

increased by2.16%

Worsened metrics

Total package byte prevSize

50250

decreased by-0.53%

No dependency changes