Skip to content

Commit 77025dc

Browse files
stephenpluspluscallmehiphop
authored andcommitted
prepare READMEs for beta release (#1864)
1 parent 49c7c71 commit 77025dc

File tree

2 files changed

+8
-21
lines changed

2 files changed

+8
-21
lines changed

packages/google-cloud-resourcemanager/README.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
# @google-cloud/resource
1+
# @google-cloud/resource ([Alpha][versioning])
22
> Google Cloud Resource Manager Client Library for Node.js
33
4-
> **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.
5-
64
*Looking for more Google APIs than just Resource Manager? You might want to check out [`google-cloud`][google-cloud].*
75

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

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

51-
### On Google Compute Engine
49+
### On Google Cloud Platform
5250

53-
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.
51+
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.
5452

5553
``` js
56-
// Authenticating on a global basis.
57-
var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123'
58-
59-
var resource = require('@google-cloud/resource')({
60-
projectId: projectId
61-
});
62-
54+
var resource = require('@google-cloud/resource')();
6355
// ...you're good to go!
6456
```
6557

6658
### Elsewhere
6759

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

7062
1. Visit the [Google Developers Console][dev-console].
7163
2. Create a new project or click on an existing project.
@@ -92,6 +84,7 @@ var resource = require('@google-cloud/resource')({
9284
```
9385

9486

87+
[versioning]: https://github.com/GoogleCloudPlatform/google-cloud-node#versioning
9588
[google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node/
9689
[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
9790
[dev-console]: https://console.developers.google.com/project

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

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,8 @@ var util = require('util');
3131
*/
3232
var Project = require('./project.js');
3333

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

0 commit comments

Comments
 (0)