Skip to content

Commit 1d90a8d

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

File tree

1 file changed

+6
-11
lines changed

1 file changed

+6
-11
lines changed

packages/google-cloud-compute/README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# @google-cloud/compute
1+
# @google-cloud/compute ([Alpha][versioning])
22
> Google Compute Engine Client Library for Node.js
33
44
*Looking for more Google APIs than just Compute Engine? You might want to check out [`google-cloud`][google-cloud].*
@@ -54,24 +54,18 @@ var gce = require('@google-cloud/compute')({
5454

5555
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.
5656

57-
### On Google Compute Engine
57+
### On Google Cloud Platform
5858

59-
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.
59+
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.
6060

6161
``` js
62-
// Authenticating on a global basis.
63-
var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123'
64-
65-
var gce = require('@google-cloud/compute')({
66-
projectId: projectId
67-
});
68-
62+
var gce = require('@google-cloud/compute')();
6963
// ...you're good to go!
7064
```
7165

7266
### Elsewhere
7367

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

7670
1. Visit the [Google Developers Console][dev-console].
7771
2. Create a new project or click on an existing project.
@@ -98,6 +92,7 @@ var gce = require('@google-cloud/compute')({
9892
```
9993

10094

95+
[versioning]: https://github.com/GoogleCloudPlatform/google-cloud-node#versioning
10196
[google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node
10297
[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
10398
[dev-console]: https://console.developers.google.com/project

0 commit comments

Comments
 (0)