Index: third_party/dom_distiller_js/protoc_plugins/README |
diff --git a/third_party/dom_distiller_js/protoc_plugins/README b/third_party/dom_distiller_js/protoc_plugins/README |
new file mode 100644 |
index 0000000000000000000000000000000000000000..02456259d89bd1dce7d867305178db2255da0229 |
--- /dev/null |
+++ b/third_party/dom_distiller_js/protoc_plugins/README |
@@ -0,0 +1,41 @@ |
+# Copyright 2014 The Chromium Authors. All rights reserved. |
nyquist
2016/06/14 00:48:11
Nit: 2016
wychen
2016/08/07 09:16:27
Done.
|
+# Use of this source code is governed by a BSD-style license that can be |
+# found in the LICENSE file. |
+ |
+These protoc plugins use a simple json encoding. |
+ |
+An instance of the following protobuf: |
+ |
+message Foo { |
nyquist
2016/06/14 00:48:11
Would it be easier to read this in markdown format
wychen
2016/08/07 09:16:27
Done.
|
+ message Bar { |
+ repeated string rabbits = 1; |
+ } |
+ optional string cat = 1; |
+ repeated int32 dog = 2; |
+ optional Bar rabbit_den = 3; |
+} |
+ |
+could be encoded 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 |
+ |