Skip to content

Commit 633b1df

Browse files
Merge pull request #853 from chohanbin/update_readme fixes #851
Update README
2 parents 618ff0d + 3421d0c commit 633b1df

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ APIs and SDKs that use cognitive computing to solve complex problems.
3636
* [Changes for v4.0](#changes-for-v40)
3737
* [Using a Proxy](#using-a-proxy)
3838
* [Android](#android)
39-
* [Running in Bluemix](#running-in-bluemix)
39+
* [Running in IBM Cloud](#running-in-ibm-cloud)
4040
* [Default Headers](#default-headers)
4141
* [Debug](#debug)
4242
* [Eclipse and Intellij](#working-with-eclipse-and-intellij-idea)
@@ -119,21 +119,21 @@ Now, you are ready to see some [examples](https://github.com/watson-developer-cl
119119
## Usage
120120

121121
The examples within each service assume that you already have service credentials. If not,
122-
you will have to create a service in [Bluemix][bluemix].
122+
you will have to create a service in [IBM Cloud][ibm_cloud].
123123

124-
If you are running your application in Bluemix, you don't need to specify the
125-
credentials; the library will get them for you by looking at the `VCAP_SERVICES` environment variable.
124+
If you are running your application in IBM Cloud (or other platforms based on Cloud Foundry), you don't need to specify the
125+
credentials; the library will get them for you by looking at the [`VCAP_SERVICES`][vcap_services] environment variable.
126126

127127
## Getting the Service Credentials
128128

129-
You will need the `username` and `password` (`api_key` for AlchemyAPI) credentials, and the API endpoint for each service. Service credentials are different from your Bluemix account username and password.
129+
You will need the `username` and `password` (`api_key` for AlchemyAPI) credentials, and the API endpoint for each service. Service credentials are different from your IBM Cloud account username and password.
130130

131131
To get your service credentials, follow these steps:
132132

133-
1. Log in to [Bluemix](https://console.bluemix.net/catalog?category=watson)
133+
1. Log in to [IBM Cloud](https://console.bluemix.net/catalog?category=watson)
134134

135135
1. Create an instance of the service:
136-
1. In the Bluemix **Catalog**, select the service you want to use.
136+
1. In the IBM Cloud **Catalog**, select the service you want to use.
137137
1. Click **Create**.
138138

139139
1. Copy your credentials:
@@ -173,14 +173,14 @@ System.out.println(workspaces);
173173

174174
For more information see: [OkHTTPClient Proxy authentication how to?](https://stackoverflow.com/a/35567936/456564)
175175

176-
## Running in Bluemix
176+
## Running in IBM Cloud
177177

178-
When running in Bluemix, the library will automatically get the credentials from `VCAP_SERVICES`.
179-
If you have more than one plan, you can use `BluemixUtils` to get the service credentials for an specific plan.
178+
When running in IBM Cloud (or other platforms based on Cloud Foundry), the library will automatically get the credentials from [`VCAP_SERVICES`][vcap_services].
179+
If you have more than one plan, you can use `CredentialUtils` to get the service credentials for an specific plan.
180180

181181
```java
182182
PersonalityInsights service = new PersonalityInsights();
183-
String apiKey = BluemixUtils.getAPIKey(service.getName(), BluemixUtils.PLAN_STANDARD);
183+
String apiKey = CredentialUtils.getAPIKey(service.getName(), CredentialUtils.PLAN_STANDARD);
184184
service.setApiKey(apiKey);
185185
```
186186

@@ -216,7 +216,7 @@ service.sentEndPoint("https://gateway-fra.watsonplatform.net/conversation/api")
216216

217217
## 401 Unauthorized error
218218

219-
Make sure you are using the service credentials and not your Bluemix account/password.
219+
Make sure you are using the service credentials and not your IBM Cloud account/password.
220220
Check the API Endpoint, you may need to update the default using `setEndPoint()`.
221221

222222
## Debug
@@ -301,11 +301,12 @@ or [Stack Overflow](http://stackoverflow.com/questions/ask?tags=ibm-watson).
301301

302302

303303
[wdc]: http://www.ibm.com/watson/developercloud/
304-
[bluemix]: https://console.bluemix.net
304+
[ibm_cloud]: https://console.bluemix.net
305305
[Gradle]: http://www.gradle.org/
306306
[OkHttp]: http://square.github.io/okhttp/
307307
[gson]: https://github.com/google/gson
308308
[apache_maven]: http://maven.apache.org/
309309
[sonatype_snapshots]: https://oss.sonatype.org/content/repositories/snapshots/com/ibm/watson/developer_cloud/
310+
[vcap_services]: https://docs.run.pivotal.io/devguide/deploy-apps/environment-variable.html#VCAP-SERVICES
310311

311312
[jar]: https://github.com/watson-developer-cloud/java-sdk/releases/download/java-sdk-4.2.0/java-sdk-4.2.1-jar-with-dependencies.jar

0 commit comments

Comments
 (0)