Skip to content

Commit b436cd2

Browse files
author
Christian Guy
authored
Merge pull request #18 from IBMStreams/readmeUpdates
Readme updates
2 parents a782e8b + 16b020a commit b436cd2

File tree

3 files changed

+13
-2
lines changed

3 files changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,16 @@ This is the initial public release. For best results you should also install th
1010
* ide-ibmstreams
1111

1212
### Setup Instructions
13-
#### Build
14-
You need to capture your VCAP credentials for IBM Streaming Analytics service in order to build.
13+
#### Build - Streaming Analytics Credentials
14+
The <b>build-ibmstreams</b> 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 <a href="https://console.bluemix.net/catalog/services/streaming-analytics" rel="noopener" target="_blank">here</a> and follow the instructions to create an account.
15+
16+
<b>Note:</b>The service needs to support V2 of the rest api.
17+
18+
Once you have an account go to your <a href="https://console.bluemix.net/dashboard/apps" rel="noopener" target="_blank">dashboard</a> 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 <b>Service Credentials</b> from the actions on the left. From the credentials page, press <b>View credentials</b> 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.
19+
20+
In Atom there is a setting in the <b>build-ibmstreams</b> package for the credentials. Go to <b>Atom->Preferences->Packages</b> and press the <b>Settings</b> button on the <b>build-ibmstreams</b> package and paste your credentials into the setting.
21+
![](./images/atomcredssetting.png)
22+
23+
24+
### SPL Application build
25+
![](./images/build.gif)

images/atomcredssetting.png

71.5 KB
Loading

images/build.gif

1.26 MB
Loading

0 commit comments

Comments
 (0)