Skip to content

Commit

Permalink
add readmes for all packages (#1495)
Browse files Browse the repository at this point in the history
* add bigquery readme

* add all readmes

* copy readme as part of release script

* gcloud-node -> google-cloud-node

* fix youre good to gos

* add resource manager scope

* exclude unecessary files
  • Loading branch information
stephenplusplus authored and callmehiphop committed Aug 26, 2016
1 parent 5f68116 commit fb463df
Show file tree
Hide file tree
Showing 2 changed files with 90 additions and 1 deletion.
89 changes: 89 additions & 0 deletions packages/google-cloud-resourcemanager/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# @google-cloud/resource
> 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]
- [Official Documentation][cloud-resource-docs]


```sh
$ npm install --save @google-cloud/resource
```
```js
var resource = require('@google-cloud/resource')({
projectId: 'grape-spaceship-123',
keyFilename: '/path/to/keyfile.json'
});

// Get all of the projects you maintain.
resource.getProjects(function(err, projects) {
if (!err) {
// `projects` contains all of your projects.
}
});

// Get the metadata from your project. (defaults to `grape-spaceship-123`)
var project = resource.project();

project.getMetadata(function(err, metadata) {
// `metadata` describes your project.
});
```


## Authentication

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

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.

``` 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
});

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

1. Visit the [Google Developers Console][dev-console].
2. Create a new project or click on an existing project.
3. Navigate to **APIs & auth** > **APIs section** and turn on the following APIs (you may need to enable billing in order to use these services):
* Google Cloud Resource Manager API
4. Navigate to **APIs & auth** > **Credentials** and then:
* If you want to use a new service account, click on **Create new Client ID** and select **Service account**. After the account is created, you will be prompted to download the JSON key file that the library uses to authenticate your requests.
* If you want to generate a new key for an existing service account, click on **Generate new JSON key** and download the JSON key file.

``` js
var projectId = process.env.GCLOUD_PROJECT; // E.g. 'grape-spaceship-123'

var resource = require('@google-cloud/resource')({
projectId: projectId,

// The path to your key file:
keyFilename: '/path/to/keyfile.json'

// Or the contents of the key file:
credentials: require('./path/to/keyfile.json')
});

// ...you're good to go!
```


[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
[gcloud-resource-docs]: https://googlecloudplatform.github.io/google-cloud-node/#/docs/resource
[cloud-resource-docs]: https://cloud.google.com/resource-manager
2 changes: 1 addition & 1 deletion packages/google-cloud-resourcemanager/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@google-cloud/resource",
"version": "0.1.1",
"author": "Google Inc.",
"description": "Google Cloud Resource Client Library for Node.js",
"description": "Google Cloud Resource Manager Client Library for Node.js",
"contributors": [
{
"name": "Burcu Dogan",
Expand Down

0 comments on commit fb463df

Please sign in to comment.