From 28abfac239ed02c11cc81bb2a987eeb5acfe085f Mon Sep 17 00:00:00 2001 From: Stephen Sawchuk Date: Thu, 8 Dec 2016 18:34:53 -0500 Subject: [PATCH] prepare READMEs for beta release (#1864) --- README.md | 19 +++++++------------ src/index.js | 6 ------ 2 files changed, 7 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index db624cf1..5c6bbcb0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# @google-cloud/logging -> Stackdriver Logging Client Library for Node.js +# @google-cloud/logging ([Beta][versioning]) +> Google Stackdriver Logging Client Library for Node.js *Looking for more Google APIs than just Logging? You might want to check out [`google-cloud`][google-cloud].* @@ -69,24 +69,18 @@ var logging = require('@google-cloud/logging')({ 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 logging = require('@google-cloud/logging')({ - projectId: projectId -}); - +var logging = require('@google-cloud/logging')(); // ...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. @@ -113,6 +107,7 @@ var logging = require('@google-cloud/logging')({ ``` +[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 diff --git a/src/index.js b/src/index.js index c98f8b83..d9839e40 100644 --- a/src/index.js +++ b/src/index.js @@ -47,12 +47,6 @@ var Log = require('./log.js'); var Sink = require('./sink.js'); /** - *

- * **This is a Beta release of Stackdriver Logging.** This API is not covered - * by any SLA or deprecation policy and may be subject to - * backward-incompatible changes. - *

- * * [Stackdriver Logging](https://cloud.google.com/logging/docs) allows you to * store, search, analyze, monitor, and alert on log data and events from Google * Cloud Platform and Amazon Web Services (AWS).