Merge pull request #6 from watson-developer-cloud/Oliver-I-UpdateReadme

Update README.md

Author: Steve Green

README.md

@@ -1 +1,140 @@
-<h1 align="center" style="border-bottom: none;">🚀 Watson Assistant Demo Sample Application</h1>
+<h1 align="center" style="border-bottom: none;">🚀 Watson Assistant (formerly Conversation) Demo Sample Application</h1>
+<h3>This app demonstrates the Watson Assistant service via a complete, complex interface which engages in simulated banking tasks.<br><br>It utilises features such as:<ul><li>Cloud Functions</li><li>Actions and UI Actions</li><li>Slots</li><li>Multi-Conditional Responses</li><li>Multi-Modal Responses</li></h3>
+
+
+You can view a [demo][demo_url] of this app.
+
+
+Please note this app uses the [Watson Assistant V2 API](https://console.bluemix.net/apidocs/assistant-v2#introduction).
+
+## Prerequisites
+
+1. Sign up for an [IBM Cloud account](https://console.bluemix.net/registration/).
+1. Download the [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cloud-cli-ibmcloud-cli#overview).
+1. Create an instance of the Watson Assistant service and get your credentials:
+    - Go to the [Watson Assistant](https://console.bluemix.net/catalog/services/conversation) page in the IBM Cloud Catalog.
+    - Log in to your IBM Cloud account.
+    - Click **Create**.
+    - Click **Show** to view the service credentials.
+    - Copy the `apikey` value, or copy the `username` and `password` values if your service instance doesn't provide an `apikey`.
+    - Copy the `url` value.
+
+## Configuring the application
+
+1. In your IBM Cloud console, open the Watson Assistant service instance
+
+2. Click the **Import workspace** icon in the Watson Assistant service tool. Specify the location of the workspace JSON file in your local copy of the app project:
+
+    `<project_root>/training/banking_workspace.json`
+
+3. Select **Everything (Intents, Entities, and Dialog)** and then click **Import**. The car dashboard workspace is created.
+
+4. Click the menu icon in the upper-right corner of the workspace tile, and then select **View details**.
+
+5. Click the ![Copy](readme_images/copy_icon.png) icon to copy the workspace ID to the clipboard.
+
+    ![Steps to get credentials](readme_images/assistant-intermediate.gif)
+
+6. In the application folder, copy the *.env.example* file and create a file called *.env*
+
+    ```
+    cp .env.example .env
+    ```
+
+7. Open the *.env* file and add the service credentials that you obtained in the previous step. The Watson SDK automaticaly locates the correct enviromental variables for either `username`, `password`, and `url` or the `apikey` and `url` credentials found in the *.env* file.
+
+    Example *.env* file that configures the `apikey` and `url` for a Watson Assistant service instance hosted in the US East region:
+
+    ```
+    ASSISTANT_IAM_APIKEY=X4rbi8vwZmKpXfowaS3GAsA7vdy17Qh7km5D6EzKLHL2
+    ASSISTANT_URL=https://gateway-wdc.watsonplatform.net/assistant/api
+    ```
+
+    - If your service instance uses `username` and `password` credentials, add the `ASSISTANT_USERNAME` and `ASSISTANT_PASSWORD` variables to the *.env* file.
+
+    Example *.env* file that configures the `username`, `password`, and `url` for a Watson Assistant service instance hosted in the US South region:
+
+    ```
+    ASSISTANT_USERNAME=522be-7b41-ab44-dec3-g1eab2ha73c6
+    ASSISTANT_PASSWORD=A4Z5BdGENrwu8
+    ASSISTANT_URL=https://gateway.watsonplatform.net/assistant/api
+    ```
+    However, if your credentials contain an IAM API key, copy the `apikey` and `url` to the relevant fields.
+    ```JSON
+      {
+        "apikey": "ca2905e6-7b5d-4408-9192-e4d54d83e604",
+        "iam_apikey_description": "Auto generated apikey during resource-key ...",
+        "iam_apikey_name": "auto-generated-apikey-62b71334-3ae3-4609-be26-846fa59ece42",
+        "iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Manager",
+        "iam_serviceid_crn": "crn:v1:bluemix:public:iam...",
+        "url": "https://gateway-syd.watsonplatform.net/assistant/api"
+      }
+    ```
+    ```
+    ASSISTANT_IAM_APIKEY=ca2905e6-7b5d-4408-9192-e4d54d83e604
+    ASSISTANT_IAM_URL=https://gateway-syd.watsonplatform.net/assistant/api
+    ```
+
+8. Add the `ASSISTANT_ID` to the previous properties
+
+    ```
+    ASSISTANT_ID=522be-7b41-ab44-dec3-g1eab2ha73c6
+    ```
+
+## Running locally
+
+1. Install the dependencies
+
+    ```
+    npm install
+    ```
+
+1. Run the application
+
+    ```
+    npm start
+    ```
+
+1. View the application in a browser at `localhost:3000`
+
+## Deploying to IBM Cloud as a Cloud Foundry Application
+
+1. Login to IBM Cloud with the [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cloud-cli-ibmcloud-cli#overview)
+
+    ```
+    ibmcloud login
+    ```
+
+1. Target a Cloud Foundry organization and space.
+
+    ```
+    ibmcloud target --cf
+    ```
+
+1. Edit the *manifest.yml* file. Change the **name** field to something unique.  
+  For example, `- name: my-app-name`.
+1. Deploy the application
+
+    ```
+    ibmcloud app push
+    ```
+
+1. View the application online at the app URL.  
+For example: https://my-app-name.mybluemix.net
+
+
+## License
+
+This sample code is licensed under Apache 2.0.  
+Full license text is available in [LICENSE](LICENSE).
+
+
+
+
+[demo_url]: http://assistant-demo.ng.bluemix.net/
+[doc_intents]: (https://cloud.ibm.com/docs/services/assistant?topic=assistant-intents#intents)
+[docs]: https://cloud.ibm.com/docs/services/assistant?topic=assistant-getting-started#getting-started
+[docs_landing]: (https://cloud.ibm.com/docs/services/assistant?topic=assistant-getting-started#getting-started)
+[node_link]: (http://nodejs.org/)
+[npm_link]: (https://www.npmjs.com/)
+[sign_up]: https://console.bluemix.net/registration