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..972d5d63 --- /dev/null +++ b/packages/grpc-protobufjs/README.md @@ -0,0 +1,19 @@ +# gRPC Protobuf Loader + +## Installation + +```sh +npm install @grpc/proto-loader +``` + +## Usage + +```js +const protoLoader = require('@grpc/proto-loader'); +const grpcLibrary = require('grpc'); +// OR +const grpcLibrary = require('@grpc/grpc-js'); +protoLoader.load(protoFile, options).then(packageDefinition => { + const package = grpcLibrary.loadPackageDefinition(packageDefinition); +}); +```