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 sofisl committed Oct 13, 2022
1 parent c65dd6d commit 757c0a6
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 19 deletions.
19 changes: 6 additions & 13 deletions packages/google-cloud-language/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# @google-cloud/language
# @google-cloud/language ([Alpha][versioning])
> Google Cloud Natural Language Client Library for Node.js
> **This is a Beta release of Google Cloud Natural Language.** 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 Natural Language? You might want to check out [`google-cloud`][google-cloud].*

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

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

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


[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
6 changes: 0 additions & 6 deletions packages/google-cloud-language/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,6 @@ var v1 = require('./v1');
var Document = require('./document.js');

/**
* <p class="notice">
* **This is a Beta release of Google Cloud Natural Language.** This API is
* not covered by any SLA or deprecation policy and may be subject to
* backward-incompatible changes.
* </p>
*
* The [Google Cloud Natural Language](https://cloud.google.com/natural-language/docs)
* API provides natural language understanding technologies to developers,
* including sentiment analysis, entity recognition, and syntax analysis. This
Expand Down

0 comments on commit 757c0a6

Please sign in to comment.