mirror of
https://github.com/titanscouting/tra-analysis.git
synced 2024-11-10 15:04:45 +00:00
80 lines
3.1 KiB
Markdown
80 lines
3.1 KiB
Markdown
|
<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
|
||
|
|
||
|
# [Google Cloud Common Module: Node.js Client](https://github.com/googlecloudplatform/google-cloud-node)
|
||
|
|
||
|
[![release level](https://img.shields.io/badge/release%20level-alpha-orange.svg?style=flat)](https://cloud.google.com/terms/launch-stages)
|
||
|
[![CircleCI](https://img.shields.io/circleci/project/github/googleapis/nodejs-common.svg?style=flat)](https://circleci.com/gh/googleapis/nodejs-common)
|
||
|
[![AppVeyor](https://ci.appveyor.com/api/projects/status/github/googleapis/nodejs-common?branch=master&svg=true)](https://ci.appveyor.com/project/googleapis/nodejs-common)
|
||
|
[![codecov](https://img.shields.io/codecov/c/github/googleapis/nodejs-common/master.svg?style=flat)](https://codecov.io/gh/googleapis/nodejs-common)
|
||
|
|
||
|
> Node.js Common package
|
||
|
|
||
|
Google Cloud Common node.js module contains stuff used by other Cloud API modules.
|
||
|
|
||
|
* [github.com/googlecloudplatform/google-cloud-node](https://github.com/googlecloudplatform/google-cloud-node)
|
||
|
|
||
|
Read more about the client libraries for Cloud APIs, including the older
|
||
|
Google APIs Client Libraries, in [Client Libraries Explained][explained].
|
||
|
|
||
|
[explained]: https://cloud.google.com/apis/docs/client-libraries-explained
|
||
|
|
||
|
**Table of contents:**
|
||
|
|
||
|
* [Quickstart](#quickstart)
|
||
|
* [Before you begin](#before-you-begin)
|
||
|
* [Installing the client library](#installing-the-client-library)
|
||
|
* [Using the client library](#using-the-client-library)
|
||
|
* [Versioning](#versioning)
|
||
|
* [Contributing](#contributing)
|
||
|
* [License](#license)
|
||
|
|
||
|
## Quickstart
|
||
|
|
||
|
### Before you begin
|
||
|
|
||
|
1. Select or create a Cloud Platform project.
|
||
|
|
||
|
[Go to the projects page][projects]
|
||
|
|
||
|
1. Enable billing for your project.
|
||
|
|
||
|
[Enable billing][billing]
|
||
|
|
||
|
1. [Set up authentication with a service account][auth] so you can access the
|
||
|
API from your local workstation.
|
||
|
|
||
|
[projects]: https://console.cloud.google.com/project
|
||
|
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
|
||
|
[auth]: https://cloud.google.com/docs/authentication/getting-started
|
||
|
|
||
|
### Installing the package
|
||
|
|
||
|
npm install --save @google-cloud/common
|
||
|
|
||
|
It's unlikely you will need to install this package directly, as it will be
|
||
|
installed as a dependency when you install other `@google-cloud` packages.
|
||
|
|
||
|
## Versioning
|
||
|
|
||
|
This library follows [Semantic Versioning](http://semver.org/).
|
||
|
|
||
|
This library is considered to be in **alpha**. This means it is still a
|
||
|
work-in-progress and under active development. Any release is subject to
|
||
|
backwards-incompatible changes at any time.
|
||
|
|
||
|
More Information: [Google Cloud Platform Launch Stages][launch_stages]
|
||
|
|
||
|
[launch_stages]: https://cloud.google.com/terms/launch-stages
|
||
|
|
||
|
## Contributing
|
||
|
|
||
|
Contributions welcome! See the [Contributing Guide](https://github.com/googlecloudplatform/google-cloud-node/blob/master/.github/CONTRIBUTING.md).
|
||
|
|
||
|
## License
|
||
|
|
||
|
Apache Version 2.0
|
||
|
|
||
|
See [LICENSE](https://github.com/googlecloudplatform/google-cloud-node/blob/master/LICENSE)
|
||
|
|
||
|
[shell_img]: http://gstatic.com/cloudssh/images/open-btn.png
|