1 | [//]: # "This README.md file is auto-generated, all changes to this file will be lost."
|
2 | [//]: # "To regenerate it, use `python -m synthtool`."
|
3 | <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"/>
|
4 |
|
5 | # [Google Cloud Common: Node.js Client](https://github.com/googleapis/nodejs-common)
|
6 |
|
7 | [![release level](https://img.shields.io/badge/release%20level-general%20availability%20%28GA%29-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages)
|
8 | [![npm version](https://img.shields.io/npm/v/@google-cloud/common.svg)](https://www.npmjs.org/package/@google-cloud/common)
|
9 | [![codecov](https://img.shields.io/codecov/c/github/googleapis/nodejs-common/master.svg?style=flat)](https://codecov.io/gh/googleapis/nodejs-common)
|
10 |
|
11 |
|
12 |
|
13 |
|
14 | Common components for Cloud APIs Node.js Client Libraries
|
15 |
|
16 |
|
17 | A comprehensive list of changes in each version may be found in
|
18 | [the CHANGELOG](https://github.com/googleapis/nodejs-common/blob/master/CHANGELOG.md).
|
19 |
|
20 | * [Google Cloud Common Node.js Client API Reference][client-docs]
|
21 |
|
22 | * [github.com/googleapis/nodejs-common](https://github.com/googleapis/nodejs-common)
|
23 |
|
24 | Read more about the client libraries for Cloud APIs, including the older
|
25 | Google APIs Client Libraries, in [Client Libraries Explained][explained].
|
26 |
|
27 | [explained]: https://cloud.google.com/apis/docs/client-libraries-explained
|
28 |
|
29 | **Table of contents:**
|
30 |
|
31 |
|
32 | * [Quickstart](#quickstart)
|
33 |
|
34 | * [Installing the client library](#installing-the-client-library)
|
35 |
|
36 |
|
37 | * [Versioning](#versioning)
|
38 | * [Contributing](#contributing)
|
39 | * [License](#license)
|
40 |
|
41 | ## Quickstart
|
42 |
|
43 | ### Installing the client library
|
44 |
|
45 | ```bash
|
46 | npm install @google-cloud/common
|
47 | ```
|
48 |
|
49 | It's unlikely you will need to install this package directly, as it will be
|
50 | installed as a dependency when you install other `@google-cloud` packages.
|
51 |
|
52 |
|
53 |
|
54 | The [Google Cloud Common Node.js Client API Reference][client-docs] documentation
|
55 | also contains samples.
|
56 |
|
57 | ## Supported Node.js Versions
|
58 |
|
59 | Our client libraries follow the [Node.js release schedule](https://nodejs.org/en/about/releases/).
|
60 | Libraries are compatible with all current _active_ and _maintenance_ versions of
|
61 | Node.js.
|
62 |
|
63 | Client libraries targetting some end-of-life versions of Node.js are available, and
|
64 | can be installed via npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).
|
65 | The dist-tags follow the naming convention `legacy-(version)`.
|
66 |
|
67 | _Legacy Node.js versions are supported as a best effort:_
|
68 |
|
69 | * Legacy versions will not be tested in continuous integration.
|
70 | * Some security patches may not be able to be backported.
|
71 | * Dependencies will not be kept up-to-date, and features will not be backported.
|
72 |
|
73 | #### Legacy tags available
|
74 |
|
75 | * `legacy-8`: install client libraries from this dist-tag for versions
|
76 | compatible with Node.js 8.
|
77 |
|
78 | ## Versioning
|
79 |
|
80 | This library follows [Semantic Versioning](http://semver.org/).
|
81 |
|
82 |
|
83 | This library is considered to be **General Availability (GA)**. This means it
|
84 | is stable; the code surface will not change in backwards-incompatible ways
|
85 | unless absolutely necessary (e.g. because of critical security issues) or with
|
86 | an extensive deprecation period. Issues and requests against **GA** libraries
|
87 | are addressed with the highest priority.
|
88 |
|
89 |
|
90 |
|
91 |
|
92 |
|
93 | More Information: [Google Cloud Platform Launch Stages][launch_stages]
|
94 |
|
95 | [launch_stages]: https://cloud.google.com/terms/launch-stages
|
96 |
|
97 | ## Contributing
|
98 |
|
99 | Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/nodejs-common/blob/master/CONTRIBUTING.md).
|
100 |
|
101 | Please note that this `README.md`, the `samples/README.md`,
|
102 | and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)
|
103 | are generated from a central template. To edit one of these files, make an edit
|
104 | to its template in this
|
105 | [directory](https://github.com/googleapis/synthtool/tree/master/synthtool/gcp/templates/node_library).
|
106 |
|
107 | ## License
|
108 |
|
109 | Apache Version 2.0
|
110 |
|
111 | See [LICENSE](https://github.com/googleapis/nodejs-common/blob/master/LICENSE)
|
112 |
|
113 | [client-docs]: https://googleapis.dev/nodejs/common/latest
|
114 |
|
115 | [shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
|
116 | [projects]: https://console.cloud.google.com/project
|
117 | [billing]: https://support.google.com/cloud/answer/6293499#enable-billing
|
118 |
|
119 | [auth]: https://cloud.google.com/docs/authentication/getting-started
|