Skip to content

Commit f0438a4

Browse files
stephenpluspluscallmehiphop
authored andcommitted
prepare READMEs for beta release (#1864)
1 parent a90c298 commit f0438a4

File tree

2 files changed

+6
-19
lines changed

2 files changed

+6
-19
lines changed

packages/google-cloud-node/README.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
# @google-cloud/speech
1+
# @google-cloud/speech ([Alpha][versioning])
22
> Google Cloud Speech Client Library for Node.js
33
4-
> **This is a Beta release of Google Cloud Speech.** This feature is not covered by any SLA or deprecation policy and may be subject to backward-incompatible changes.
5-
64
*Looking for more Google APIs than just Speech? You might want to check out [`google-cloud`][google-cloud].*
75

86
- [API Documentation][gcloud-speech-docs]
@@ -78,24 +76,18 @@ var speech = require('@google-cloud/speech')({
7876

7977
It's incredibly easy to get authenticated and start using Google's APIs. You can set your credentials on a global basis as well as on a per-API basis. See each individual API section below to see how you can auth on a per-API-basis. This is useful if you want to use different accounts for different Google Cloud services.
8078

81-
### On Google Compute Engine
79+
### On Google Cloud Platform
8280

83-
If you are running this client on Google Compute Engine, we handle authentication for you with no configuration. You just need to make sure that when you [set up the GCE instance][gce-how-to], you add the correct scopes for the APIs you want to access.
81+
If you are running this client on Google Cloud Platform, we handle authentication for you with no configuration. You just need to make sure that when you [set up the GCE instance][gce-how-to], you add the correct scopes for the APIs you want to access.
8482

8583
``` js
86-
// Authenticating on a global basis.
87-
var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123'
88-
89-
var speech = require('@google-cloud/speech')({
90-
projectId: projectId
91-
});
92-
84+
var speech = require('@google-cloud/speech')();
9385
// ...you're good to go!
9486
```
9587

9688
### Elsewhere
9789

98-
If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account:
90+
If you are not running this client on Google Cloud Platform, you need a Google Developers service account. To create a service account:
9991

10092
1. Visit the [Google Developers Console][dev-console].
10193
2. Create a new project or click on an existing project.
@@ -122,6 +114,7 @@ var speech = require('@google-cloud/speech')({
122114
```
123115

124116

117+
[versioning]: https://github.com/GoogleCloudPlatform/google-cloud-node#versioning
125118
[google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node/
126119
[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
127120
[dev-console]: https://console.developers.google.com/project

packages/google-cloud-node/src/index.js

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,6 @@ var v1beta1 = require('./v1beta1');
4646
* @alias module:speech
4747
*
4848
* @classdesc
49-
* <p class="notice">
50-
* **This is a Beta release of Google Cloud Speech.** This feature is not
51-
* covered by any SLA or deprecation policy and may be subject to
52-
* backward-incompatible changes.
53-
* </p>
54-
*
5549
* To learn more about the Speech API, see the
5650
* [Getting Started guide](https://cloud.google.com/speech/docs/getting-started).
5751
*

0 commit comments

Comments
 (0)