aboutsummaryrefslogtreecommitdiffhomepage
path: root/js/README.md
diff options
context:
space:
mode:
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