Skip to content

Commit

Permalink
prepare READMEs for beta release (#1864)
Browse files Browse the repository at this point in the history
  • Loading branch information
stephenplusplus authored and callmehiphop committed Dec 8, 2016
1 parent f44a366 commit 1d90a8d
Showing 1 changed file with 6 additions and 11 deletions.
17 changes: 6 additions & 11 deletions packages/google-cloud-compute/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @google-cloud/compute
# @google-cloud/compute ([Alpha][versioning])
> Google Compute Engine Client Library for Node.js
*Looking for more Google APIs than just Compute Engine? You might want to check out [`google-cloud`][google-cloud].*
Expand Down Expand Up @@ -54,24 +54,18 @@ var gce = require('@google-cloud/compute')({

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.

### On Google Compute Engine
### On Google Cloud Platform

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

``` js
// Authenticating on a global basis.
var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123'

var gce = require('@google-cloud/compute')({
projectId: projectId
});

var gce = require('@google-cloud/compute')();
// ...you're good to go!
```

### Elsewhere

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

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


[versioning]: https://github.com/GoogleCloudPlatform/google-cloud-node#versioning
[google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node
[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
[dev-console]: https://console.developers.google.com/project
Expand Down

0 comments on commit 1d90a8d

Please sign in to comment.