/client/nodejs-component/node_modules/protobufjs/examples/protoify/README.md

ProtoBuf.js protoify example

============================

This example shows the general usage of ProtoBuf.js by converting JSON structures to protocol buffers and vice versa

using a definition describing JSON itself. While this works as an example, it does not provide any real world benefits

(well, this is if you are not building a protobuf-backed database for JSON data, using inter-field substitution to

minimize redundancy - nevermind, forget that).



Instructions

------------

1. Set up dependencies: `npm install`

2. Run: `npm test`



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':



* **[index.js](https://github.com/dcodeIO/ProtoBuf.js/blob/master/examples/protoify/index.js)**

  contains the sample's source code



* **[json.proto](https://github.com/dcodeIO/ProtoBuf.js/blob/master/examples/protoify/json.proto)**

  contains the protobuf definition used



* **[json.json](https://github.com/dcodeIO/ProtoBuf.js/blob/master/examples/protoify/json.json)**

  contains the protobuf definition converted through `proto2js json.proto > json.json`



* **[json.js](https://github.com/dcodeIO/ProtoBuf.js/blob/master/examples/protoify/json.js)**

  contains the protobuf definition converted through `proto2js json.proto -commonjs=js > json.js`



* **[test.js](https://github.com/dcodeIO/ProtoBuf.js/blob/master/examples/protoify/test.js)**

  contains our simple test suite