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 49c7c71 commit 77025dc
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 21 deletions.
19 changes: 6 additions & 13 deletions packages/google-cloud-resourcemanager/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# @google-cloud/resource
# @google-cloud/resource ([Alpha][versioning])
> Google Cloud Resource Manager Client Library for Node.js
> **This is a Beta release of Google Cloud Resource Manager.** This feature is not covered by any SLA or deprecation policy and may be subject to backward-incompatible changes.
*Looking for more Google APIs than just Resource Manager? You might want to check out [`google-cloud`][google-cloud].*

- [API Documentation][gcloud-resource-docs]
Expand Down Expand Up @@ -48,24 +46,18 @@ var resource = require('@google-cloud/resource')({

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 resource = require('@google-cloud/resource')({
projectId: projectId
});

var resource = require('@google-cloud/resource')();
// ...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 @@ -92,6 +84,7 @@ var resource = require('@google-cloud/resource')({
```


[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
10 changes: 2 additions & 8 deletions packages/google-cloud-resourcemanager/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,8 @@ var util = require('util');
*/
var Project = require('./project.js');

/**
* <p class="notice">
* **This is a Beta release of Cloud Resource Manager.** This feature is not
* covered by any SLA or deprecation policy and may be subject to
* backward-incompatible changes.
* </p>
*
* [The Cloud Resource Manager](https://cloud.google.com/resource-manager/)
/** *
* The [Cloud Resource Manager](https://cloud.google.com/resource-manager/)
* provides methods that you can use to programmatically manage your projects
* in the Google Cloud Platform. With this API, you can do the following:
*
Expand Down

0 comments on commit 77025dc

Please sign in to comment.