Skip to content

Commit

Permalink
fix: Add installation step for @google-cloud/logging-min NPM package …
Browse files Browse the repository at this point in the history
…in README (#1239)

* fix: Add installation step for @google-cloud/logging-min NPM package in README

The NPM page for `@google-cloud/logging-min` is the same as `@google-cloud/logging`. This can cause some confusion on what the difference are and how to install the correct package: `npm install @google-cloud/logging` vs `npm install @google-cloud/logging-min`.
Fixes #[1126](#1126).

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* Update .readme-partials.yml

Add @google-cloud/logging-min installation instructions

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
losalex and gcf-owl-bot[bot] authored Mar 29, 2022
1 parent 7434d64 commit f31e3ed
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 7 deletions.
10 changes: 7 additions & 3 deletions .readme-partials.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,12 @@ introduction: |-
If you require lightweight dependencies, an experimental, minified version of
this library is available at [@google-cloud/logging-min](https://www.npmjs.com/package/@google-cloud/logging-min).
Note: `logging-min` is experimental, and its feature surface is subject to
change.
Note: `logging-min` is experimental, and its feature surface is subject to change.
To install `@google-cloud/logging-min` library run the following command:
```bash
npm install @google-cloud/logging-min
```
body: |-
## Batching Writes
Expand Down Expand Up @@ -125,4 +129,4 @@ body: |-
const log = logging.log('my-log', options);
```
See the full sample in `writeLogWithCallback` function [here](https://github.com/googleapis/nodejs-logging/blob/master/samples/logs.js).
See the full sample in `writeLogWithCallback` function [here](https://github.com/googleapis/nodejs-logging/blob/master/samples/logs.js).
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,12 @@ monitor, and alert on log data and events from Google Cloud Platform and Amazon

If you require lightweight dependencies, an experimental, minified version of
this library is available at [@google-cloud/logging-min](https://www.npmjs.com/package/@google-cloud/logging-min).
Note: `logging-min` is experimental, and its feature surface is subject to
change.
Note: `logging-min` is experimental, and its feature surface is subject to change.
To install `@google-cloud/logging-min` library run the following command:

```bash
npm install @google-cloud/logging-min
```


A comprehensive list of changes in each version may be found in
Expand Down
8 changes: 6 additions & 2 deletions samples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,12 @@ monitor, and alert on log data and events from Google Cloud Platform and Amazon

If you require lightweight dependencies, an experimental, minified version of
this library is available at [@google-cloud/logging-min](https://www.npmjs.com/package/@google-cloud/logging-min).
Note: `logging-min` is experimental, and its feature surface is subject to
change.
Note: `logging-min` is experimental, and its feature surface is subject to change.
To install `@google-cloud/logging-min` library run the following command:

```bash
npm install @google-cloud/logging-min
```

## Table of Contents

Expand Down

0 comments on commit f31e3ed

Please sign in to comment.