Skip to content

Update README to rename Bluemix to IBM Cloud #318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 13, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ _2016-08-26_
* Deprecated: Retired `Dialog` service.
* Fix: `ExampleLanguageTranslation` now is using `LanguageTranslator` before `LanguageTranslation` service goes live.
* Fix: Abstracted custom voice model methods in `Text to Speech` service.
* Fix: Error when pasting credentials from the new Bluemix site into the `Config Editor`.
* Fix: Error when pasting credentials from the new IBM Cloud site into the `Config Editor`.
* New: Added `CameraWidget` and `CameraDisplayWidget` to get video from device camera.
* New: Added test scene for using the device camera with the `Visual Recognition` service.

Expand Down
48 changes: 26 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,30 @@
# Watson Developer Cloud Unity SDK
# Watson APIs Unity SDK
[![Build Status](https://travis-ci.org/watson-developer-cloud/unity-sdk.svg?branch=develop)](https://travis-ci.org/watson-developer-cloud/unity-sdk)

Use this SDK to build Watson-powered applications in Unity.

## Table of Contents
* [Before you begin](#before-you-begin)
* [Getting the Watson SDK and adding it to Unity](#getting-the-watson-sdk-and-adding-it-to-unity)
* [Installing the SDK source into your Unity project](#installing-the-sdk-source-into-your-unity-project)
* [Configuring your service credentials](#configuring-your-service-credentials)
* [Authentication](#authentication)
* [Watson Services](#watson-services)
* [Authentication Tokens](#authentication-tokens)
* [Documentation](#documentation)
* [Questions](#questions)
* [Open Source @ IBM](#open-source--ibm)
* [License](#license)
* [Contributing](#contributing)
<details>
<summary>Table of Contents</summary>

* [Before you begin](#before-you-begin)
* [Getting the Watson SDK and adding it to Unity](#getting-the-watson-sdk-and-adding-it-to-unity)
* [Installing the SDK source into your Unity project](#installing-the-sdk-source-into-your-unity-project)
* [Configuring your service credentials](#configuring-your-service-credentials)
* [Authentication](#authentication)
* [Watson Services](#watson-services)
* [Authentication Tokens](#authentication-tokens)
* [Documentation](#documentation)
* [Questions](#questions)
* [Open Source @ IBM](#open-source--ibm)
* [License](#license)
* [Contributing](#contributing)

</details>

## Before you begin
Ensure that you have the following prerequisites:

* An IBM Bluemix account. If you don't have one, [sign up][bluemix_registration].
* An IBM Cloud account. If you don't have one, [sign up][ibm_cloud_registration].
* [Unity][get_unity]. You can use the **free** Personal edition.
* Change the build settings in Unity (**File > Build Settings**) to any platform except for web player/Web GL. The Watson Developer Cloud Unity SDK does not support Unity Web Player.

Expand All @@ -33,16 +37,16 @@ Move the **`unity-sdk`** directory into the **`Assets`** directory of your Unity
## Configuring your service credentials
To create instances of Watson services and their credentials, follow the steps below.

**Note:** Service credentials are different from your Bluemix account username and password.
**Note:** Service credentials are different from your IBM Cloud account username and password.

1. Determine which services to configure.
1. If you have configured the services already, complete the following steps. Otherwise, go to step 3.
1. Log in to Bluemix at https://bluemix.net.
1. Log in to IBM Cloud at https://console.bluemix.net.
1. Click the service you would like to use.
1. Click **Service credentials**.
1. Click **View credentials** to access your credentials.
1. If you need to configure the services that you want to use, complete the following steps.
1. Log in to Bluemix at https://bluemix.net.
1. Log in to IBM Cloud at https://console.bluemix.net.
1. Click the **Create service** button.
1. Under **Watson**, select which service you would like to create an instance of and click that service.
1. Give the service and credential a name. Select a plan and click the **Create** button on the bottom.
Expand All @@ -56,7 +60,7 @@ The credentials for each service contain either a `username`, `password` and end

## Watson Services
To get started with the Watson Services in Unity, click on each service below to read through each of their `README.md`'s and their codes.
* [Alchemy Language](/Scripts/Services/AlchemyAPI/v1)
* [Alchemy Language](/Scripts/Services/AlchemyAPI/v1) **Deprecated**
* [Conversation](/Scripts/Services/Conversation/v1)
* [Discovery](/Scripts/Services/Discovery/v1)
* [Document Conversion](/Scripts/Services/DocumentConversion/v1) **Deprecated**
Expand All @@ -68,7 +72,7 @@ To get started with the Watson Services in Unity, click on each service below to
* [Speech to Text](/Scripts/Services/SpeechToText/v1)
* [Text to Speech](/Scripts/Services/TextToSpeech/v1)
* [Tone Analyzer](/Scripts/Services/ToneAnalyzer/v3)
* [Tradeoff Analytics](/Scripts/Services/TradeoffAnalytics/v1)
* [Tradeoff Analytics](/Scripts/Services/TradeoffAnalytics/v1) **Deprecated**
* [Visual Recognition](/Scripts/Services/VisualRecognition/v3)

## Authentication
Expand Down Expand Up @@ -183,7 +187,7 @@ private void OnFail(RESTConnector.Error error, Dictionary<string, object> custom
## Authentication Tokens
You use tokens to write applications that make authenticated requests to IBM Watson™ services without embedding service credentials in every call.

You can write an authentication proxy in IBM® Bluemix® that obtains and returns a token to your client application, which can then use the token to call the service directly. This proxy eliminates the need to channel all service requests through an intermediate server-side application, which is otherwise necessary to avoid exposing your service credentials from your client application.
You can write an authentication proxy in IBM Cloud that obtains and returns a token to your client application, which can then use the token to call the service directly. This proxy eliminates the need to channel all service requests through an intermediate server-side application, which is otherwise necessary to avoid exposing your service credentials from your client application.

```cs
using IBM.Watson.DeveloperCloud.Services.Conversation.v1;
Expand Down Expand Up @@ -240,7 +244,7 @@ See [CONTRIBUTING.md](.github/CONTRIBUTING.md).
[wdc]: https://www.ibm.com/watson/developer/
[wdc_unity_sdk]: https://github.com/watson-developer-cloud/unity-sdk
[latest_release]: https://github.com/watson-developer-cloud/unity-sdk/releases/latest
[bluemix_registration]: http://bluemix.net/registration
[ibm_cloud_registration]: http://console.bluemix.net/registration
[get_unity]: https://unity3d.com/get-unity

[speech_to_text]: https://console.bluemix.net/docs/services/speech-to-text/index.html
Expand Down
2 changes: 1 addition & 1 deletion Scripts/Services/TradeoffAnalytics/v1/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Tradeoff Analytics

**NOTE:** The IBM Watson™ Tradeoff Analytics service is being deprecated. As of May 11, 2017, it will no longer be possible to create a new instance of the service on Bluemix. Existing service instances will continue to be supported until April 11, 2018.
**NOTE:** The IBM Watson™ Tradeoff Analytics service is being deprecated. As of May 11, 2017, it will no longer be possible to create a new instance of the service on IBM Cloud. Existing service instances will continue to be supported until April 11, 2018.

The [Tradeoff Analytics][tradeoff_analytics] service helps people make better decisions when faced with multiple, sometimes conflicting, goals and alternatives.

Expand Down