Skip to content

Commit

Permalink
Docs: Added toolset diagram to README
Browse files Browse the repository at this point in the history
  • Loading branch information
dcodeIO committed Apr 5, 2017
1 parent 16e3c94 commit 0d8100b
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Contents
* [Using services](#using-services)
* [Usage with TypeScript](#usage-with-typescript)


* [Command line](#command-line)<br />
How to use the command line utility.

Expand All @@ -32,6 +33,7 @@ Contents
* [Reflection vs. static code](#reflection-vs-static-code)
* [Command line API](#command-line-api)


* [Additional documentation](#additional-documentation)<br />
A list of available documentation resources.

Expand Down Expand Up @@ -172,9 +174,13 @@ Note that **Message** below refers to any message type. See the next section for

See also: [ConversionOptions](http://dcode.io/protobuf.js/global.html#ConversionOptions)

In pictures:

<img alt="Toolset Diagram" src="http://dcode.io/protobuf.js/toolset.svg" />

### Valid message

A valid message is an object not missing any required fields and exclusively using JS types for its fields that are understood by the wire format writer.
A valid message is an object not missing any required fields and exclusively using JS types for its fields / properties that are understood by the wire format writer.

* Calling `Message.verify` with any object returns `null` if the object can be encoded as-is and otherwise the error as a string.
* Calling `Message.create` or `Message.encode` must be called with a valid message.
Expand Down

0 comments on commit 0d8100b

Please sign in to comment.