aboutsummaryrefslogtreecommitdiff
path: root/js/README.md
diff options
context:
space:
mode:
authorJosh Haberman <jhaberman@gmail.com>2015-12-21 15:18:17 -0800
committerJosh Haberman <jhaberman@gmail.com>2015-12-21 15:22:49 -0800
commite9cf31e68b8c5c20b8d1155b01260aca4006cfd2 (patch)
tree772f921ee2cc885a6df7a0a04ad1cf8f23cb44cb /js/README.md
parent27b2423d6a73f0a3c9f05021052067a485a84397 (diff)
downloadprotobuf-e9cf31e68b8c5c20b8d1155b01260aca4006cfd2.tar.gz
protobuf-e9cf31e68b8c5c20b8d1155b01260aca4006cfd2.tar.bz2
protobuf-e9cf31e68b8c5c20b8d1155b01260aca4006cfd2.zip
Added README and enabled JavaScript tests on Node.js
Diffstat (limited to 'js/README.md')
-rw-r--r--js/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/js/README.md b/js/README.md
new file mode 100644
index 00000000..fc144a3d
--- /dev/null
+++ b/js/README.md
@@ -0,0 +1,14 @@
+This directory contains Protocol Buffer support for JavaScript. This code works
+in browsers and in Node.js.
+
+The packaging work for this is still in-progress. For now you can just run the
+tests. First you need to build the main C++ distribution because the code
+generator for JavaScript is written in C++:
+
+ $ ./autogen.sh
+ $ ./configure
+ $ make
+
+Then you can run the JavaScript tests in this directory:
+
+ $ cd js && gulp test