| Index: third_party/dom_distiller_js/protoc_plugins/README.md
|
| diff --git a/third_party/dom_distiller_js/protoc_plugins/README.md b/third_party/dom_distiller_js/protoc_plugins/README.md
|
| new file mode 100644
|
| index 0000000000000000000000000000000000000000..8c788c16c129b6937d13670d71130936ee908283
|
| --- /dev/null
|
| +++ b/third_party/dom_distiller_js/protoc_plugins/README.md
|
| @@ -0,0 +1,40 @@
|
| +# protoc plugin for JSON converter
|
| +
|
| +These protoc plugins use a simple JSON encoding.
|
| +
|
| +An instance of the following protobuf:
|
| +
|
| +```
|
| +message Foo {
|
| + message Bar {
|
| + repeated string rabbits = 1;
|
| + }
|
| + optional string cat = 1;
|
| + repeated int32 dog = 2;
|
| + optional Bar rabbit_den = 3;
|
| +}
|
| +```
|
| +
|
| +could be encoded to something like:
|
| +
|
| +```
|
| +{
|
| + "1": "kitty",
|
| + "2": [4, 16, 9],
|
| + "3": { "1": ["thumper", "oreo", "daisy"] }
|
| +}
|
| +```
|
| +
|
| +Only a limited part of the protocol buffer IDL is supported.
|
| +
|
| +* Supported field types: `float`, `double`, `int32`, `bool`, `string`, `message`, and `enum`
|
| +
|
| +* Supported field rules: `optional`, `repeated`
|
| +
|
| +* Unsupported features:
|
| +
|
| + * default values
|
| + * imports
|
| + * extensions
|
| + * services
|
| + * non-file-level options
|
|
|