Merged in pat-explorer-doc (pull request #520)

doc updates for explorer

docs/source/node-explorer.rst

@@ -34,18 +34,19 @@ Running Demo Nodes
 Interface
 ---------
 Login
-  User can login to any Corda node using the explorer, alternately, `gradlew explorer:runDemoNodes` can be used to start up demo nodes for testing.  
+  User can login to any Corda node using the explorer. Alternatively, ``gradlew explorer:runDemoNodes`` can be used to start up demo nodes for testing.  
   Corda node address, username and password are required for login, the address is defaulted to localhost:0 if leave blank.
-  Username and password can be configured in node's configuration file; for demo nodes, it is defaulted to ``user1`` and ``test``.
-
+  Username and password can be configured via the ``rpcUsers`` field in node's configuration file; for demo nodes, it is defaulted to ``user1`` and ``test``.
+  
 .. note:: If you are connecting to the demo nodes, only Alice and Bob (20004, 20006) are accessible using user1 credential, you won't be able to connect to the notary.
 
 .. image:: resources/explorer/login.png
    :scale: 50 %
    :align: center
      
-Home
-  Home view shows the top level state of node and vault; currently, it shows your cash balance and the numbers of transaction executed.
+Dashboard
+  The dashboard shows the top level state of node and vault.
+  Currently, it shows your cash balance and the numbers of transaction executed.
   The dashboard is intended to house widgets from different CordApp's and provide useful information to system admin at a glance. 
 
 .. image:: resources/explorer/dashboard.png
@@ -56,6 +57,13 @@ Cash
 
 .. image:: resources/explorer/vault.png
 
+New cash transaction
+  This is where you can create new cash transactions. 
+  The user can choose from three transaction types (issue, pay and exit) and any party visible on the network. 
+  The result of the transaction will be visible in the transaction screen when executed.
+
+.. image:: resources/explorer/newTransaction.png
+
 Transactions
   The transaction view contains all transactions handled by the node in a table view. It shows basic information on the table e.g. Transaction ID, 
   command type, USD equivalence value etc. User can expand the row by double clicking to view the inputs, 
@@ -63,9 +71,17 @@ Transactions
   
 .. image:: resources/explorer/transactionView.png
 
-New Transaction
-  This is where you can create new transaction; currently only the cash contract is supported. 
-  The user can choose from three transaction types (issue, move and exit) and any party visible on the network. 
-  The result of the transaction will be visible in the transaction screen when executed.
+Network
+  The network view shows the network information on the world map. Currently only the user's node is rendered on the map. 
+  This will be extended to other peers in a future release.
+  The map provides a intuitive way of visualizing the Corda network and the participants. 
 
-.. image:: resources/explorer/newTransaction.png
+.. image:: resources/explorer/network.png
+
+
+Settings
+  User can configure the client preference in this view.
+.. note:: Although the reporting currency is configurable, FX conversion won't be applied to the values as we don't have an FX service yet.
+
+
+.. image:: resources/explorer/settings.png

tools/explorer/README.md

@@ -0,0 +1,44 @@
+# Node Explorer
+
+The node explorer provide views of the node's vault and transaction data using Corda's RPC framework.
+The user can execute cash transaction commands to issue and move cash to other parties on the network or exit cash using the user interface.
+
+## Running the UI
+
+**Windows:**
+
+    gradlew.bat tools:explorer:run
+
+**Other:**
+
+    ./gradlew tools:explorer:run
+    
+
+## Running Demo Nodes
+
+**Windows:**
+
+    gradlew.bat tools:explorer:runDemoNodes
+
+**Other:**
+
+    ./gradlew tools:explorer:runDemoNodes
+
+**These Corda nodes will be created on the following port on localhost.**
+
+    Notary -> 20002
+    Alice -> 20004
+    Bob -> 20006
+    Bank of Corda -> 20008
+  
+
+## TODOs:
+- Shows more useful information in the dashboard.
+- Improve Network View, display other nodes in the world map and show transactions between them.
+- Add a new view showing node's state machines.
+- Link transaction input to its originated transaction to make it easier to trace back.
+- Shows Node information (Configuration, properties etc.) in Settings view. 
+- Support other contract types.
+
+
+More information can be found in the [Project website](https://corda.net) and [Documentation](https://docs.corda.net).