Skip to content

Commit

Permalink
chore: update package name (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
SurferJeffAtGoogle authored Jun 8, 2021
1 parent 44faee5 commit e793013
Show file tree
Hide file tree
Showing 12 changed files with 331 additions and 221 deletions.
2 changes: 1 addition & 1 deletion packages/google-cloud-privatecatalog/.repo-metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"release_level": "BETA",
"language": "nodejs",
"repo": "googleapis/nodejs-private-catalog",
"distribution_name": "",
"distribution_name": "@google-cloud/private-catalog",
"api_id": "privatecatalog.googleapis.com",
"default_version": "v1beta1",
"requires_billing": true
Expand Down
Empty file.
46 changes: 42 additions & 4 deletions packages/google-cloud-privatecatalog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# [Private Catalog: Node.js Client](https://github.com/googleapis/nodejs-private-catalog)

[![release level](https://img.shields.io/badge/release%20level-beta-yellow.svg?style=flat)](https://cloud.google.com/terms/launch-stages)
[![npm version](https://img.shields.io/npm/v/.svg)](https://www.npmjs.org/package/)
[![npm version](https://img.shields.io/npm/v/@google-cloud/private-catalog.svg)](https://www.npmjs.org/package/@google-cloud/private-catalog)
[![codecov](https://img.shields.io/codecov/c/github/googleapis/nodejs-private-catalog/master.svg?style=flat)](https://codecov.io/gh/googleapis/nodejs-private-catalog)


Expand All @@ -32,8 +32,8 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
* [Quickstart](#quickstart)
* [Before you begin](#before-you-begin)
* [Installing the client library](#installing-the-client-library)


* [Using the client library](#using-the-client-library)
* [Samples](#samples)
* [Versioning](#versioning)
* [Contributing](#contributing)
* [License](#license)
Expand All @@ -51,11 +51,49 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
### Installing the client library

```bash
npm install
npm install @google-cloud/private-catalog
```


### Using the client library

```javascript
// Imports the Google Cloud client library

// remove this line after package is released
// eslint-disable-next-line node/no-missing-require
const {PrivateCatalogClient} = require('');

// TODO(developer): replace with your prefered project ID.
// const projectId = 'my-project'

// Creates a client
// eslint-disable-next-line no-unused-vars
const client = new {PrivateCatalogClient}();

//TODO(library generator): write the actual function you will be testing
async function doSomething() {
console.log(
'DPE! Change this code so that it shows how to use the library! See comments below on structure.'
);
// const [thing] = await client.methodName({
// });
// console.info(thing);
}
doSomething();

```



## Samples

Samples are in the [`samples/`](https://github.com/googleapis/nodejs-private-catalog/tree/master/samples) directory. Each sample's `README.md` has instructions for running its sample.

| Sample | Source Code | Try it |
| --------------------------- | --------------------------------- | ------ |
| Quickstart | [source code](https://github.com/googleapis/nodejs-private-catalog/blob/master/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-private-catalog&page=editor&open_in_editor=samples/quickstart.js,samples/README.md) |



The [Private Catalog Node.js Client API Reference][client-docs] documentation
Expand Down
4 changes: 2 additions & 2 deletions packages/google-cloud-privatecatalog/package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "undefined",
"name": "@google-cloud/private-catalog",
"version": "0.1.0",
"description": "cloudprivatecatalog client for Node.js",
"repository": "googleapis/googleapis/nodejs-private-catalog",
"repository": "googleapis/nodejs-private-catalog",
"license": "Apache-2.0",
"author": "Google LLC",
"main": "build/src/index.js",
Expand Down
28 changes: 14 additions & 14 deletions packages/google-cloud-privatecatalog/protos/protos.d.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

58 changes: 29 additions & 29 deletions packages/google-cloud-privatecatalog/protos/protos.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

50 changes: 50 additions & 0 deletions packages/google-cloud-privatecatalog/samples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
[//]: # "This README.md file is auto-generated, all changes to this file will be lost."
[//]: # "To regenerate it, use `python -m synthtool`."
<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"/>

# [Private Catalog: Node.js Samples](https://github.com/googleapis/nodejs-private-catalog)

[![Open in Cloud Shell][shell_img]][shell_link]



## Table of Contents

* [Before you begin](#before-you-begin)
* [Samples](#samples)
* [Quickstart](#quickstart)

## Before you begin

Before running the samples, make sure you've followed the steps outlined in
[Using the client library](https://github.com/googleapis/nodejs-private-catalog#using-the-client-library).

`cd samples`

`npm install`

`cd ..`

## Samples



### Quickstart

View the [source code](https://github.com/googleapis/nodejs-private-catalog/blob/master/samples/quickstart.js).

[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-private-catalog&page=editor&open_in_editor=samples/quickstart.js,samples/README.md)

__Usage:__


`node samples/quickstart.js`






[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
[shell_link]: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-private-catalog&page=editor&open_in_editor=samples/README.md
[product-docs]: https://cloud.google.com/private-catalog/
2 changes: 1 addition & 1 deletion packages/google-cloud-privatecatalog/samples/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"test": "c8 mocha --timeout 600000 test/*.js"
},
"dependencies": {
"": "^0.1.0"
"@google-cloud/private-catalog": "^0.1.0"
},
"devDependencies": {
"c8": "^7.1.0",
Expand Down
Loading

0 comments on commit e793013

Please sign in to comment.