Built motion from commit 6a09e18b.|2.6.11

[motion2.git] / legacy-libs / grpc-cloned / node_modules / protobufjs / examples / protoify / README.md

diff --git a/legacy-libs/grpc-cloned/node_modules/protobufjs/examples/protoify/README.md b/legacy-libs/grpc-cloned/node_modules/protobufjs/examples/protoify/README.md
new file mode 100644 (file)
index 0000000..e82333b
--- /dev/null
+++ b/legacy-libs/grpc-cloned/node_modules/protobufjs/examples/protoify/README.md
@@ -0,0 +1,28 @@
+ProtoBuf.js protoify example\r
+============================\r
+This example shows the general usage of ProtoBuf.js by converting JSON structures to protocol buffers and vice versa\r
+using a definition describing JSON itself. While this works as an example, it does not provide any real world benefits\r
+(well, this is if you are not building a protobuf-backed database for JSON data, using inter-field substitution to\r
+minimize redundancy - nevermind, forget that).\r
+\r
+Instructions\r
+------------\r
+1. Set up dependencies: `npm install`\r
+2. Run: `npm test`\r
+\r
+Now you know no more and no less than that it works and you might want to inspect the following files to get the 'how':\r
+\r
+* **[index.js](https://github.com/dcodeIO/ProtoBuf.js/blob/master/examples/protoify/index.js)**\r
+  contains the sample's source code\r
+\r
+* **[json.proto](https://github.com/dcodeIO/ProtoBuf.js/blob/master/examples/protoify/json.proto)**\r
+  contains the protobuf definition used\r
+\r
+* **[json.json](https://github.com/dcodeIO/ProtoBuf.js/blob/master/examples/protoify/json.json)**\r
+  contains the protobuf definition converted through `proto2js json.proto > json.json`\r
+\r
+* **[json.js](https://github.com/dcodeIO/ProtoBuf.js/blob/master/examples/protoify/json.js)**\r
+  contains the protobuf definition converted through `proto2js json.proto -commonjs=js > json.js`\r
+\r
+* **[test.js](https://github.com/dcodeIO/ProtoBuf.js/blob/master/examples/protoify/test.js)**\r
+  contains our simple test suite\r