aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar murgatroid99 <mlumish@google.com>2015-05-13 11:08:42 -0700
committerGravatar murgatroid99 <mlumish@google.com>2015-05-13 11:08:42 -0700
commitc880cad41c191c6ce4974eb3d0bc33b8671aa31c (patch)
treee15aff75a8da5052200c5746218feaec21db88a3
parentb70d1d9dcac2281f2a7d76bd243ec490736f49ec (diff)
Added service_packager description to bin/README.md
-rw-r--r--src/node/bin/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/node/bin/README.md b/src/node/bin/README.md
new file mode 100644
index 0000000000..2f856e428e
--- /dev/null
+++ b/src/node/bin/README.md
@@ -0,0 +1,16 @@
+# Command Line Tools
+
+# Service Packager
+
+The command line tool `bin/service_packager`, when called with the following command line:
+
+```bash
+service_packager proto_file -o output_path -n name -v version [-i input_path...]
+```
+
+Populates `output_path` with a node package consisting of a `package.json` populated with `name` and `version`, an `index.js`, a `LICENSE` file copied from gRPC, and a `service.json`, which is compiled from `proto_file` and the given `input_path`s. `require('output_path')` returns an object that is equivalent to
+
+```js
+{ client: require('grpc').load('service.json'),
+ auth: require('google-auth-library') }
+```