mirror of https://github.com/grpc/grpc-node.git
				
				
				
			Add README files for new packages
This commit is contained in:
		
							parent
							
								
									68c4ca311a
								
							
						
					
					
						commit
						f5ff760bd3
					
				|  | @ -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` | ||||
|  |  | |||
|  | @ -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. | ||||
|  | @ -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); | ||||
| }); | ||||
| ``` | ||||
		Loading…
	
		Reference in New Issue