Merge pull request #10 from AnthonyAmanse/update-readme

Add alternative deployments to README

Author: AnthonyAmanse

README-Deploy-UI.md

@@ -0,0 +1,24 @@
+# Deploy through the IBM Cloud Functions console user interface
+
+* Create a Trigger
+Click on `Create Trigger` then choose `Cloudant`. At the **Cloudant Instance** section, choose to "Input your own credentials". Enter your Cloudant's **Username**, **Password**, **Host**. Enter `images` as your **Database** if you have created that name of the database at the previous step. Name the Trigger "update-trigger".
+
+![create-trigger](docs/create-trigger.png)
+
+* Then click on `Add +` on the **Connected Actions section** then choose `Create Action` with a `Node.js 8` as the **Runtime**. Name the action "update-document-with-watson".
+
+![connected-action](docs/connected-action.png)
+
+![create-action](docs/create-action.png)
+
+* Then click on the action and copy and paste the code in [`actions/updateDocumentWithWatson.js`](actions/updateDocumentWithWatson.js) to the editor in the browser.
+
+![action](docs/action.png)
+
+![code-action](docs/code-action.png)
+
+* Then go to the `Parameters` section and add these parameters with the values of your own.
+
+![parameters](docs/parameters.png)
+
+You may now proceed to [Step 4 in the main README](README.md#4-launch-application)

README.md

@@ -59,15 +59,26 @@ Create a [**Cloudant**](https://console.bluemix.net/catalog/services/cloudant) i
 Create a [Watson Visual Recognition](https://console.bluemix.net/catalog/services/visual-recognition) instance.
 * Copy the API Key in the Credentials section and paste it in the `local.env` file in the value of `WATSON_VISUAL_APIKEY`
 
-### 3. Create Cloud Functions
+### 3. Deploy Cloud Functions
+> Choose one of the deployment methods
 
-Make sure you have the right environment variables in the `local.env` file. Export them in your terminal then deploy the Cloud Functions using `wskdeploy`:
+## Deploy through the IBM Cloud Functions console user interface
+
+Choose ["Start Creating"](https://console.bluemix.net/openwhisk/create) in the IBM Cloud Functions Dashboard. [Then proceed to this deployment instructions using the UI](README-Deploy-UI.md).
+
+You can also deploy them directly from the CLI by following the steps in the next section.
+
+## Deploy using the wskdeploy command line tool
+
+Make sure you have the right environment variables in the `local.env` file. Export them in your terminal then deploy the Cloud Functions using `wskdeploy`. This uses the `manifest.yaml` file in this root directory.
 
 ```
 $ source local.env
 $ wskdeploy
 ```
 
+> You may want to undeploy them later with `wskdeploy undeploy`
+
 ### 4. Launch Application
 
 Configure `web/scripts/upload.js`. Modify the lines for your Cloudant credentials.
@@ -91,6 +102,66 @@ $ npm start
 
 ![sample-output](docs/screenshot.png)
 
+# Alternative Deployment Methods
+
+### Deploy manually with the `ibmcloud wsk` command line tool
+
+This approach shows you how to deploy individual the packages, actions, triggers, and rules with CLI commands. It helps you understand and control the underlying deployment artifacts.
+
+* Export credentials
+```
+$ source local.env
+```
+
+* Create Cloudant Binding
+
+```
+$ ibmcloud wsk package bind /whisk.system/cloudant serverless-pattern-cloudant-package \
+-p username $CLOUDANT_USERNAME \
+-p password $CLOUDANT_PASSWORD \
+-p host ${CLOUDANT_USERNAME}.cloudant.com
+```
+
+* Create the Cloudant Trigger
+
+The trigger will listen to changes in the `images` database.
+
+```
+$ ibmcloud wsk trigger create update-trigger --feed serverless-pattern-cloudant-package/changes \
+--param dbname images
+```
+
+* Create the Action
+
+The action executes your code. The code is already configured to use the Watson SDK.
+
+```
+$ ibmcloud wsk action create update-document-with-watson actions/updateDocumentWithWatson.js \
+--kind nodejs:8 \
+--param USERNAME $CLOUDANT_USERNAME \
+--param PASSWORD $CLOUDANT_PASSWORD \
+--param DBNAME $CLOUDANT_IMAGE_DATABASE \
+--param DBNAME_PROCESSED $CLOUDANT_TAGS_DATABASE \
+--param WATSON_VR_APIKEY $WATSON_VISUAL_APIKEY
+```
+
+* Create the Rule
+
+The rule will connect invoke the action when the trigger receives an event.
+
+```
+$ ibmcloud wsk rule create update-trigger-rule update-trigger update-document-with-watson
+```
+
+* To delete them
+
+```
+$ ibmcloud wsk package delete serverless-pattern-cloudant-package
+$ ibmcloud wsk trigger delete update-trigger
+$ ibmcloud wsk action delete update-document-with-watson
+$ ibmcloud wsk rule delete update-trigger-rule
+```
+
 # Links
 
 * [Apache OpenWhisk](http://openwhisk.incubator.apache.org/): Open source cloud platform that executes functions in response to events at any scale.