Skip to content

Commit 7f4dffe

Browse files
author
Paul Johnston
committed
Add readme badge
1 parent 9045fe9 commit 7f4dffe

2 files changed

Lines changed: 15 additions & 4 deletions

File tree

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,20 @@
11
# bzl-sdk-node
22

3-
This repository contains the generated protobuf definitions for the Bzl gRPC API
4-
as well as a more developer-friendly index.js entrypoint.
3+
[![NPM version](https://img.shields.io/npm/v/@stackb/bzl-sdk-node.svg)](https://www.npmjs.com/package/@stackb/bzl-sdk-node)
54

6-
API definitions: https://github.com/stackb/apis/tree/master/build/stack/bzl/v1beta
5+
This repository contains the generated protobuf definitions for the
6+
[Bzl](https://build.bzl.io) gRPC API as well as a more developer-friendly
7+
index.js entrypoint.
8+
9+
Canonical API definitions are at https://github.com/stackb/apis/tree/master/build/stack/bzl/v1beta
10+
11+
## Usage
12+
13+
```
14+
npm install @stackb/bzl-sdk-node
15+
```
16+
17+
Given a running process (e.g. `bzl serve`), connect to the server and retrieve metadata:
718

819
```js
920
const v1beta1 = require('@stackb/bzl-sdk-node').v1beta;

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "@stackb/bzl-sdk-node",
33
"displayName": "Bzl SDK for Node",
44
"description": "SDK for the Bzl API (nodejs)",
5-
"version": "0.0.1",
5+
"version": "0.0.2",
66
"categories": [
77
"Other"
88
],

0 commit comments

Comments
 (0)