From 8f86a61dbbbce7df8cce9494fd8395a19a689ffd Mon Sep 17 00:00:00 2001 From: murgatroid99 Date: Thu, 14 Sep 2017 12:59:34 -0700 Subject: [PATCH] Update package descriptions in README, add API docs link --- README.md | 6 +++--- packages/grpc-native-core/README.md | 3 +++ 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4b8d11c6..9e362a77 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ ### C-based Client and Server -Directory: [`packages/grpc-native-core`](https://github.com/grpc/grpc-node/tree/master/packages/grpc-native-core) +Directory: [`packages/grpc-native-core`](https://github.com/grpc/grpc-node/tree/master/packages/grpc-native-core) (see here for installation information) npm package: [grpc](https://www.npmjs.com/package/grpc). -This library will continue to be the canonical, feature rich implementation of gRPC, with broad but incomplete platform support. +This is the existing, feature-rich implementation of gRPC using a C++ addon. It works on all LTS versions of Node.js on most platforms that Node.js runs on. ### Pure JavaScript Client @@ -16,7 +16,7 @@ Directory: [`packages/grpc-js-core`](https://github.com/grpc/grpc-node/tree/mast **This library is currently incomplete and experimental, built on the [experimental http2 Node module](https://nodejs.org/api/http2.html).** -This library is a minimally-featured implementation of gRPC purely in JavaScript, without a C++ addon. It is intended for use in libraries that need complete platform support and only basic gRPC features. +This library implements the core functionality of gRPC purely in JavaScript, without a C++ addon. It works on the latest version of Node.js (with the `--expose-http2` flag set) on all platforms that Node.js runs on. ## Other Packages diff --git a/packages/grpc-native-core/README.md b/packages/grpc-native-core/README.md index 3b98b978..200b2fca 100644 --- a/packages/grpc-native-core/README.md +++ b/packages/grpc-native-core/README.md @@ -31,6 +31,9 @@ npm install grpc To fix this, you will have to delete the folder `C:\Users\\.node-gyp\\include\node\openssl` and retry `npm install` +## API DOCUMENTATION + +See the [API Documentation](https://grpc.io/grpc/node/). ## TESTING To run the test suite, simply run `npm test` in the install location.