dnrops
/
remarshal
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(readme/wrappers): mention CBOR in section

This commit is contained in:
D. Bohdan 2020-06-02 20:58:29 +00:00
parent 5528389120
commit bf03a22ae8
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -100,11 +100,11 @@ string the result of the conversion is written to the standard output.
### Wrappers
The arguments `--wrap` and `--unwrap` are there to solve the problem of
converting JSON, MessagePack, and YAML data to TOML if the top-level element
of that data is not of a dictionary type (i.e., not an object in JSON, a map
in MessagePack, or an associative array in YAML) but a list, a string, or
a number. Such data can not be represented as TOML directly; it needs to be
wrapped in a dictionary first. Passing the flag `--wrap someKey` to
converting CBOR, JSON, MessagePack, and YAML data to TOML if the top-level
element of that data is not of a dictionary type (i.e., not a map in CBOR and
MessagePack, an object in JSON, or an associative array in YAML) but a list,
a string, or a number. Such data can not be represented as TOML directly; it
must be wrapped in a dictionary first. Passing the flag `--wrap someKey` to
`remarshal` or one of its short commands wraps the input data in a "wrapper"
dictionary with one key, "someKey", with the input data as its value.
The flag `--unwrap someKey` does the opposite: if it is specified only