diff --git a/README.md b/README.md index b738424..6be59b7 100644 --- a/README.md +++ b/README.md @@ -10,5 +10,16 @@ This is the initial public release. For best results you should also install th * ide-ibmstreams ### Setup Instructions -#### Build -You need to capture your VCAP credentials for IBM Streaming Analytics service in order to build. \ No newline at end of file +#### Build - Streaming Analytics Credentials +The build-ibmstreams package requires a running IBM Streaming Analytics service. SPL applications will be built and deployed on this service. If you need to create one, start here and follow the instructions to create an account. + +Note:The service needs to support V2 of the rest api. + +Once you have an account go to your dashboard and select the Streaming Analytic service you want to use. You need to make sure it is running and then copy your credentials to the clipboard. To get your credentials select Service Credentials from the actions on the left. From the credentials page, press View credentials for the one you want to use and press the copy button in the upper right side of the credentials to copy them to the clipboard. + +In Atom there is a setting in the build-ibmstreams package for the credentials. Go to Atom->Preferences->Packages and press the Settings button on the build-ibmstreams package and paste your credentials into the setting. +![](./images/atomcredssetting.png) + + +### SPL Application build +![](./images/build.gif) \ No newline at end of file diff --git a/images/atomcredssetting.png b/images/atomcredssetting.png new file mode 100644 index 0000000..267abce Binary files /dev/null and b/images/atomcredssetting.png differ diff --git a/images/build.gif b/images/build.gif new file mode 100644 index 0000000..d0a5ef7 Binary files /dev/null and b/images/build.gif differ