Skip to content

Commit 45e759b

Browse files
committed
docs: readme updates for v4
1 parent 931bc08 commit 45e759b

File tree

1 file changed

+5
-8
lines changed

1 file changed

+5
-8
lines changed

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,9 @@ Credentials are checked for in the following order:
6565
1. Hard-coded or programatic credentials passed to the service constructor
6666

6767
2. Environment variables:
68-
- `SERVICE_NAME_USERNAME` and `SERVICE_NAME_PASSWORD` environment properties (or `SERVICE_NAME_API_KEY` when appropriate) and, optionally, `SERVICE_NAME_URL`
68+
- `SERVICE_NAME_USERNAME` and `SERVICE_NAME_PASSWORD` environment properties
6969
- If using IAM: `SERVICE_NAME_IAM_APIKEY` and optionally `SERVICE_NAME_IAM_URL`, or `SERVICE_NAME_IAM_ACCESS_TOKEN`
70+
- Optionally, `SERVICE_NAME_URL`
7071

7172
3. IBM-Cloud-supplied credentials (via the `VCAP_SERVICES` JSON-encoded environment property)
7273

@@ -478,10 +479,6 @@ compareComply.compareDocuments(
478479

479480
```
480481

481-
### Conversation
482-
483-
This service has been renamed to Assistant.
484-
485482
### Discovery
486483

487484
Use the [Discovery Service][discovery] to search and analyze structured and unstructured data.
@@ -794,10 +791,10 @@ visualRecognition.classify(params, function(err, res) {
794791
## Composing services
795792
796793
### Integration of Tone Analyzer with Conversation
797-
Sample code for [integrating Tone Analyzer and Conversation][conversation_tone_analyzer_example] is provided in the [examples directory][examples].
794+
Sample code for [integrating Tone Analyzer and Assistant][assistant_tone_analyzer_example] is provided in the [examples directory][examples].
798795
799796
## Unauthenticated requests
800-
By default, the library tries to use Basic Auth and will ask for `api_key` or `username` and `password` and send an `Authorization: Basic XXXXXXX`. You can avoid this by using:
797+
By default, the library tries to authenticate and will ask for `iam_apikey`, `iam_access_token`, or `username` and `password` to send an `Authorization` header. You can avoid this by using:
801798
802799
`use_unauthenticated`.
803800
@@ -857,7 +854,7 @@ See [CONTRIBUTING](https://github.com/watson-developer-cloud/node-sdk/blob/maste
857854
[request_github]: https://github.com/request/request
858855
[examples]: https://github.com/watson-developer-cloud/node-sdk/tree/master/examples
859856
[document_conversion_integration_example]: https://github.com/watson-developer-cloud/node-sdk/tree/master/examples/document_conversion_integration.v1.js
860-
[conversation_tone_analyzer_example]: https://github.com/watson-developer-cloud/node-sdk/tree/master/examples/conversation_tone_analyzer_integration
857+
[assistant_tone_analyzer_example]: https://github.com/watson-developer-cloud/node-sdk/tree/master/examples/conversation_tone_analyzer_integration
861858
[license]: http://www.apache.org/licenses/LICENSE-2.0
862859
[vcap_services]: https://console.bluemix.net/docs/services/watson/getting-started-variables.html
863860
[ibm-cloud-onboarding]: http://console.bluemix.net/registration?target=/developer/watson&cm_sp=WatsonPlatform-WatsonServices-_-OnPageNavLink-IBMWatson_SDKs-_-Node

0 commit comments

Comments
 (0)