Skip to content

Commit

Permalink
[#471] Update README.md and ZserioJsonGuide.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Mi-La authored and mikir committed Aug 8, 2023
1 parent 0c46723 commit d63813b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Zserio is a framework for serializing structured data with a compact and efficie

You can define your structured data in [Zserio language](doc/ZserioLanguageOverview.md) and then you can use
special generated source code in [several languages](#language-support) to easily write and read your data to
and from a [binary](doc/ZserioEncodingGuide.md) or [text](doc/ZserioJsonGuide.md) stream.
and from a [binary](doc/ZserioEncodingGuide.md) or a [text](doc/ZserioJsonGuide.md) stream.

No time to read? Go to the [quick start](#quick-start) or [download latest release](https://github.com/ndsev/zserio/releases/latest).

Expand Down
7 changes: 5 additions & 2 deletions doc/ZserioJsonGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
Zserio supports encoding in JSON to have readable format allowing users convenient way of data inspection, e.g.
for debugging purposes. This JSON encoding is described by this document.

> Note that JSON debug string is available only when `-withTypeInfoCode` option is used.
> Moreover in C++ it's available only when `-withReflectionCode` option is used.
[Simple Example](#simple-example)

[JSON Mapping](#json-mapping)
Expand Down Expand Up @@ -85,8 +88,8 @@ error. This behavior allows users to update Zserio object partially which might
purposes. However, users should be aware that partial update of Zserio object might leave object in inconsistent
state.

In another hand, generation of JSON data from an inconsistent Zserio object is not possible and fails
with error.
> Note that it's also not required to have a fully initialized object to be able to write it to JSON data.
> Thus it's possible to use JSON format for debugging in both directions, reading and writing.
The JSON encoding is described for all Zserio types in the table below:

Expand Down

0 comments on commit d63813b

Please sign in to comment.