From 37e3518ff784d60829860f937b4e5dc7cd7c341b Mon Sep 17 00:00:00 2001 From: murgatroid99 Date: Fri, 4 Aug 2017 11:02:10 -0700 Subject: [PATCH] Rewrite README, separate current state information from plan information --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ea4051cd..6bbda817 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ -Given the [community effort](https://github.com/nodejs/node/pull/14239) to bring an _experimental_ http2 stack for nodejs, the gRPC team decided to start exploring the feasibility of using it. The code you'll find in this repository is not meant for public consumption, and is by no means production-ready. Ultimately, the goal for this repository is to provide a basic [gRPC](https://grpc.io) implementation, without the all of the rich features. +# Pure JavaScript Node gRPC Client -The production-ready, generally available, feature-rich and maintained version of the gRPC Node.js module can be found [on npmjs](https://www.npmjs.com/package/grpc), or [on github](https://github.com/grpc/grpc/tree/master/src/node). +**This library is currently incomplete and experimental, built on the [upcoming experimental http2 Node module](https://github.com/nodejs/node/pull/14239).** The existing, working gRPC Node.js module can be found [on npm](https://www.npmjs.com/package/grpc) and [on github](https://github.com/grpc/grpc/tree/master/src/node). + +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. + +The existing gRPC Node.js module will continue to be the canonical, feature rich implementation of gRPC, with broad but incomplete platform support.