PageRenderTime 44ms CodeModel.GetById 14ms RepoModel.GetById 0ms app.codeStats 0ms

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

https://github.com/sapo/sapo-broker
Markdown | 55 lines | 46 code | 9 blank | 0 comment | 0 complexity | 99f521d8ba8321d96dcb2302c078e987 MD5 | raw file
Possible License(s): GPL-3.0, BSD-3-Clause, CC-BY-SA-3.0, Apache-2.0 
    

  1. ![ProtoBuf.js - Protocol Buffers for JavaScript. Finally.](https://raw.github.com/dcodeIO/ProtoBuf.js/master/ProtoBuf.png)

    2. 

  2. =====================================

    3. 

  3. **Protocol Buffers** are a language-neutral, platform-neutral, extensible way of serializing structured data for use

    4. 

  4. in communications protocols, data storage, and more, originally designed at Google ([see](https://developers.google.com/protocol-buffers/docs/overview)).

    5. 

  5. 

    6. 

  6. **ProtoBuf.js** is a pure JavaScript implementation on top of [ByteBuffer.js](https://github.com/dcodeIO/ByteBuffer.js)

    7. 

  7. including a .proto parser, message class building and simple encoding and decoding. There is no compilation step

    8. 

  8. required, it's super easy to use and it works out of the box on .proto files!

    9. 

  9. 

    10. 

  10. [![Build Status](https://travis-ci.org/dcodeIO/ProtoBuf.js.svg?branch=master)](https://travis-ci.org/dcodeIO/ProtoBuf.js)

    11. 

  11. [![Donate](https://raw.githubusercontent.com/dcodeIO/Long.js/master/donate.png)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=info%40code-emitter.com&item_name=Open%20Source%3A%20ProtoBuf.js)

    12. 

  12. 

    13. 

  13. Getting started

    14. 

  14. ---------------

    15. 

  15. * **Step 1:** Become familar with [Google's Protocol Buffers (protobuf)](https://developers.google.com/protocol-buffers/docs/overview)

    16. 

  16. * **Step 2:** Head straight to [our wiki for up to date usage information, changes and examples](https://github.com/dcodeIO/ProtoBuf.js/wiki)

    17. 

  17. * **Step 3:** Build something cool! :-)

    18. 

  18. 

    19. 

  19. Features

    20. 

  20. --------

    21. 

  21. * [RequireJS](http://requirejs.org/)/AMD compatible

    22. 

  22. * [node.js](http://nodejs.org)/CommonJS compatible, also available via [npm](https://npmjs.org/package/protobufjs)

    23. 

  23. * Browser compatible

    24. 

  24. * [Closure Compiler](https://developers.google.com/closure/compiler/) compatible (fully annotated, [externs](https://github.com/dcodeIO/ProtoBuf.js/tree/master/externs))

    25. 

  25. * Fully documented using [jsdoc3](https://github.com/jsdoc3/jsdoc)

    26. 

  26. * Well tested through [test.js](https://github.com/dcodeIO/test.js)

    27. 

  27. * [ByteBuffer.js](https://github.com/dcodeIO/ByteBuffer.js) is the only production dependency

    28. 

  28. * Fully compatible to the official implementation including advanced features

    29. 

  29. * Small footprint (even smaller if you use a noparse build)

    30. 

  30. * proto2js command line utility

    31. 

  31. 

    32. 

  32. Documentation

    33. 

  33. -------------

    34. 

  34. * [Read the official protobuf guide](https://developers.google.com/protocol-buffers/docs/overview)

    35. 

  35. * [Read our wiki](https://github.com/dcodeIO/ProtoBuf.js/wiki)

    36. 

  36. * [Read the API docs](http://htmlpreview.github.io/?https://raw.githubusercontent.com/dcodeIO/ProtoBuf.js/master/docs/ProtoBuf.html)

    37. 

  37. * [Check out the examples](https://github.com/dcodeIO/ProtoBuf.js/tree/master/examples)

    38. 

  38. 

    39. 

  39. Tests

    40. 

  40. -----

    41. 

  41. * [View source](https://github.com/dcodeIO/ProtoBuf.js/blob/master/tests/suite.js)

    42. 

  42. * [View report](https://travis-ci.org/dcodeIO/ProtoBuf.js)

    43. 

  43. 

    44. 

  44. Downloads

    45. 

  45. ---------

    46. 

  46. * [Distributions](https://github.com/dcodeIO/ProtoBuf.js/tree/master/dist)

    47. 

  47. * [ZIP-Archive](https://github.com/dcodeIO/ProtoBuf.js/archive/master.zip)

    48. 

  48. * [Tarball](https://github.com/dcodeIO/ProtoBuf.js/tarball/master)

    49. 

  49. 

    50. 

  50. Contributors

    51. 

  51. ------------

    52. 

  52. [Daniel Wirtz](https://github.com/dcodeIO) (maintainer), [Frank Xu](https://github.com/yyfrankyy),

    53. 

  53. [Dretch](https://github.com/Dretch), [shirmin](https://github.com/shirmin), [Nikolai Vavilov](https://github.com/seishun)

    54. 

  54. 

    55. 

  55. **License:** [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) - Logo derived from [W3C HTML5 Logos](http://www.w3.org/html/logo/) (CC A 3.0)

    56. 

  56.