Skip to content

Commit 0d8100b

Browse files
committed
Docs: Added toolset diagram to README
1 parent 16e3c94 commit 0d8100b

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Contents
2424
* [Using services](#using-services)
2525
* [Usage with TypeScript](#usage-with-typescript)
2626

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

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

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

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

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

177+
In pictures:
178+
179+
<img alt="Toolset Diagram" src="http://dcode.io/protobuf.js/toolset.svg" />
180+
175181
### Valid message
176182

177-
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.
183+
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.
178184

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

0 commit comments

Comments
 (0)