Updates the Node.js README to match the common template

pull/3109/head
Tim Emiola 10 years ago
parent 2eadf58ab6
commit f3e73a4871
  1. 15
      node/README.md

@ -1,17 +1,21 @@
# gRPC Node.js Helloworld gRPC in 3 minutes (Node.js)
===========================
## INSTALLATION REQUIREMENTS PREREQUISITES
-------------
This requires Node 10.x or greater. This requires Node 10.x or greater.
## INSTALL INSTALL
-------
- Clone this repository - Clone this repository
- Follow the instructions in [INSTALL](https://github.com/grpc/grpc/blob/master/INSTALL) to install the gRPC C core. - Follow the instructions in [INSTALL](https://github.com/grpc/grpc/blob/master/INSTALL) to install the gRPC C core.
- Run `npm install` to install dependencies - Run `npm install` to install dependencies
- If `grpc` is not found, clone the [gRPC](https://github.com/grpc/grpc) repository and run `npm install path/to/grpc/src/node`. - If `grpc` is not found, clone the [gRPC](https://github.com/grpc/grpc) repository and run `npm install path/to/grpc/src/node`.
## USAGE Try it!
-------
- Run the server - Run the server
@ -27,7 +31,8 @@ This requires Node 10.x or greater.
$ nodejs ./greeter_client.js $ nodejs ./greeter_client.js
``` ```
## NOTE Note
----
This directory has a copy of `helloworld.proto` because it currently depends on This directory has a copy of `helloworld.proto` because it currently depends on
some Protocol Buffer 2.0 syntax that is deprecated in Protocol Buffer 3.0. some Protocol Buffer 2.0 syntax that is deprecated in Protocol Buffer 3.0.

Loading…
Cancel
Save