From f5ff760bd3ba6d5ad917d8861a406281124ced66 Mon Sep 17 00:00:00 2001 From: murgatroid99 Date: Wed, 28 Mar 2018 12:52:34 -0700 Subject: [PATCH] Add README files for new packages --- README.md | 6 ++++++ packages/grpc-js-core/README.md | 20 ++++++++++++++++++++ packages/grpc-protobufjs/README.md | 16 ++++++++++++++++ 3 files changed, 42 insertions(+) create mode 100644 packages/grpc-js-core/README.md create mode 100644 packages/grpc-protobufjs/README.md diff --git a/README.md b/README.md index bd8826a8..9bcebd56 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,12 @@ This library implements the core functionality of gRPC purely in JavaScript, wit ## Other Packages +### gRPC Protobuf Loader + +Directory: [`packages/grpc-protobufjs`](https://github.com/grpc/grpc-node/tree/master/packages/grpc-protobufjs) + +This library loads `.proto` files into objects that can be passed to the gRPC libraries. + ### gRPC Tools Directory: `packages/grpc-tools` diff --git a/packages/grpc-js-core/README.md b/packages/grpc-js-core/README.md new file mode 100644 index 00000000..054986ca --- /dev/null +++ b/packages/grpc-js-core/README.md @@ -0,0 +1,20 @@ +# Pure JavaScript gRPC Client + +## Installation + +Node 9.x or greater is required. + +```sh +npm install @grpc/grpc-js +``` + +## Features + + - Unary and streaming calls + - Cancellation + - Deadlines + - TLS channel credentials + - Call credentials (for auth) + - Simple reconnection + +This library does not directly handle `.proto` files. To use `.proto` files with this library we recommend using the `@grpc/proto-loader` package. diff --git a/packages/grpc-protobufjs/README.md b/packages/grpc-protobufjs/README.md new file mode 100644 index 00000000..bf2f7f5c --- /dev/null +++ b/packages/grpc-protobufjs/README.md @@ -0,0 +1,16 @@ +# gRPC Protobuf Loader + +## Installation + +```sh +npm install @grpc/proto-loader +``` + +## Usage + +```js +const protoLoader = require('@grpc/proto-loader') +protoLoader.load(protoFile, options).then(packageDefinition => { + package = grpcLibrary.loadPackageDefinition(packageDefinition); +}); +```