Release 0.2.5

README.md

@@ -2,33 +2,41 @@
 
 The Sudo Decentralized Cloud Agent Admin Console implements a Sample Web UI to control the process of
 creating, issuing and holding Verifiable Credentials. This Web UI utilises the
-Sudo Decentralized Identity Cloud Agent SDK to create a local, standalone,
+[Sudo Decentralized Identity Cloud Agent SDK](https://sudoplatform-labs.github.io/sudo-di-cloud-agent-js/) to create a local, standalone,
 Decentralized Identity development environment.
 
 _NOTE:_ Currently only MacOS is supported as a development environment and Chrome Browser for the Web UI.
 
+## Version Support
+
+| Technology     | Supported version |
+| -------------- | ----------------- |
+| docker desktop | 3.1.0             |
+| yarn           | 1.22.10           |
+| node           | 12.6.2            |
+
 ## <a name="setup_instructions"></a>Setup / Running standalone environment
 
 Before begining these instructions you must have [yarn](https://yarnpkg.com) and [docker desktop](https://hub.docker.com/editions/community/docker-ce-desktop-mac) installed on your machine.
 
 1. Clone this github repository.
 2. Change to the top level project directory
 3. Run `yarn bootstrap`.
-   This will initialise the `node_modules` directory with project dependencies.
-4. Edit `public/acapy.json` and add element "endorserSeed": “<32 byte seed>”,
+   This will initialise the `node_modules` directory with project dependencies, including the [Sudo Decentralized Identity Cloud Agent SDK](https://sudoplatform-labs.github.io/sudo-di-cloud-agent-js/).
+4. Edit `public/acapy.json` and add element `"endorserSeed": “<your unique/secret 32 byte seed>”,`
 5. Start the local development environment using the installed
-   `@sudoplatform-labs/sudo-di-cloud-agent` command `yarn di-env start -c $PWD/public/acapy.json`.
-   This will download and start local docker instances of both a VON Indy Ledger and the
-   Sudo Cloud Agency Service. (see di-env for other command options).
+   [Sudo Decentralized Identity Cloud Agent SDK](https://sudoplatform-labs.github.io/sudo-di-cloud-agent-js/), command `yarn di-env start -c $PWD/public/acapy.json`.
+   This will download and start local docker instances of both a [VON Network](https://github.com/bcgov/von-network) Indy Ledger and the
+   Sudo Cloud Agency Service, which is derived from the [hyperledger Aries Cloud Agent Python](https://github.com/hyperledger/aries-cloudagent-python). See `yarn di-env -h` for other command options.
 6. Run `yarn start` to begin serving the Web UI.
 7. Browse to the web page url at `localhost:3000`
 8. Stop the local development environment when finished using `yarn di-env down`.
-   NOTE: This will destroy all credentials, schemas and DIDs created.
+   **NOTE:** This will destroy all credentials, schemas and DIDs created.
 
 **_Troubleshooting_**
 
-It is possible that the `yarn di-env down/start` commands could fail. Instances of this occuring usually relate to a change of the node_modules/@sudoplatform-labs/sudo-di-cloud-agent
-package whilst the environment is running. The simplest way to recover from such errors is to manualy terminate the docker containers related to the VON-network and sudo-di-cloud-agent.
+It is possible that the `yarn di-env down/start` commands could fail. Instances of this occuring usually relate to a change of the `node_modules/@sudoplatform-labs/sudo-di-cloud-agent`
+package whilst the environment is running (e.g. performing a `yarn upgrade`). The simplest way to recover from such errors is to manualy terminate the docker containers related to the VON-network and sudo-di-cloud-agent (i.e. via the docker desktop user interface).
 
 ## Using a Public Ledger and Public Cloud Agent Endpoint
 
@@ -38,6 +46,6 @@ It is recommended that as much development activity as possible is performed wit
 The Web UI can support using a public ledger such as [Sovrin BuilderNet or StagingNet](https://sovrin.org/overview).
 When using these ledgers the UI will automatically display the Transaction Authorisation Agreement and require acceptance before any ledger write operation (e.g Schema Creation, Credential Definition, DID Writes).
 
-For details on starting the Development Environment with public ledgers and/or a public cloud agent endpoint, refer to the [Sudo Decentralized Identity Cloud Agent SDK](https://www.npmjs.com/package/@sudoplatform-labs/sudo-di-cloud-agent) documentation.
+For details on starting the Development Environment with public ledgers and/or creating a public Cloud Agent endpoint, refer to the [Sudo Decentralized Identity Cloud Agent SDK](https://www.npmjs.com/package/@sudoplatform-labs/sudo-di-cloud-agent) documentation.
 
-**NOTE:** It is unnecessary to perform the TAA acceptance steps in the SDK documentation as the Web UI will handle this automatically when appropriate.
+**NOTE:** It is unnecessary to perform the TAA acceptance steps in the [Sudo Decentralized Identity Cloud Agent SDK](https://sudoplatform-labs.github.io/sudo-di-cloud-agent-js/) documentation as the Web UI will handle this automatically when appropriate.

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sudoplatform-labs/sudo-di-cloud-agent-admin-console",
   "description": "Sudo Decentalized Identity Cloud Agent Admin Console Application",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "author": "Anonyome Platform Team",
   "license": "Apache-2.0",
   "files": [