diff options
Diffstat (limited to 'js/README.md')
-rw-r--r-- | js/README.md | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/js/README.md b/js/README.md index ef0d4b19..2c142222 100644 --- a/js/README.md +++ b/js/README.md @@ -1,7 +1,7 @@ Protocol Buffers - Google's data interchange format =================================================== -[![Build Status](https://travis-ci.org/google/protobuf.svg?branch=master)](https://travis-ci.org/google/protobuf) +[![Build status](https://storage.googleapis.com/protobuf-kokoro-results/status-badge/linux-javascript.png)](https://fusion.corp.google.com/projectanalysis/current/KOKORO/prod:protobuf%2Fgithub%2Fmaster%2Fubuntu%2Fjavascript%2Fcontinuous) [![Build status](https://storage.googleapis.com/protobuf-kokoro-results/status-badge/macos-javascript.png)](https://fusion.corp.google.com/projectanalysis/current/KOKORO/prod:protobuf%2Fgithub%2Fmaster%2Fmacos%2Fjavascript%2Fcontinuous) Copyright 2008 Google Inc. @@ -25,7 +25,7 @@ To use Protocol Buffers with JavaScript, you need two main components: 2. The Protocol Compiler `protoc`. This translates `.proto` files into `.js` files. The compiler is not currently available via npm, but you can download a pre-built binary - [on GitHub](https://github.com/google/protobuf/releases) + [on GitHub](https://github.com/protocolbuffers/protobuf/releases) (look for the `protoc-*.zip` files under **Downloads**). @@ -33,11 +33,11 @@ Setup ===== First, obtain the Protocol Compiler. The easiest way is to download -a pre-built binary from [https://github.com/google/protobuf/releases](https://github.com/google/protobuf/releases). +a pre-built binary from [https://github.com/protocolbuffers/protobuf/releases](https://github.com/protocolbuffers/protobuf/releases). If you want, you can compile `protoc` from source instead. To do this follow the instructions in [the top-level -README](https://github.com/google/protobuf/blob/master/src/README.md). +README](https://github.com/protocolbuffers/protobuf/blob/master/src/README.md). Once you have `protoc` compiled, you can run the tests by typing: @@ -135,7 +135,7 @@ The syntax of the `--js_out` flag is: Where `OPTIONS` are separated by commas. Options are either `opt=val` or just `opt` (for options that don't take a value). The available options are specified and documented in the `GeneratorOptions` struct in -[src/google/protobuf/compiler/js/js_generator.h](https://github.com/google/protobuf/blob/master/src/google/protobuf/compiler/js/js_generator.h#L53). +[src/google/protobuf/compiler/js/js_generator.h](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/compiler/js/js_generator.h#L53). Some examples: @@ -144,6 +144,7 @@ Some examples: The `import_style` option is left to the default, which is `closure`. - `--js_out=import_style=commonjs,binary:protos`: this contains the options `import_style=commonjs` and `binary` and outputs to the directory `protos`. + `import_style=commonjs_strict` doesn't expose the output on the global scope. API === |