Skip to content

Commit

Permalink
Some README edits
Browse files Browse the repository at this point in the history
  • Loading branch information
Fatal1ty committed Nov 19, 2023
1 parent c718d38 commit 7ea5de8
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,6 @@ Table of contents
* [Supported serialization formats](#supported-serialization-formats)
* [Basic form](#basic-form)
* [JSON](#json)
* [json library](#json-library)
* [orjson library](#orjson-library)
* [YAML](#yaml)
* [TOML](#toml)
* [MessagePack](#messagepack)
Expand Down Expand Up @@ -409,10 +407,10 @@ Efficient decoder and encoder can be used as:
from mashumaro.codecs import BasicDecoder, BasicEncoder
# or from mashumaro.codecs.basic import BasicDecoder, BasicEncoder

decoder = BasicDecoder(<shape_type>)
decoder = BasicDecoder(<shape_type>, ...)
decoder.decode(...)

encoder = BasicEncoder(<shape_type>)
encoder = BasicEncoder(<shape_type>, ...)
encoder.encode(...)
```

Expand Down Expand Up @@ -455,10 +453,10 @@ Efficient decoder and encoder can be used as:
```python
from mashumaro.codecs.json import JSONDecoder, JSONEncoder

decoder = JSONDecoder(<shape_type>)
decoder = JSONDecoder(<shape_type>, ...)
decoder.decode(...)

encoder = JSONEncoder(<shape_type>)
encoder = JSONEncoder(<shape_type>, ...)
encoder.encode(...)
```

Expand Down Expand Up @@ -510,10 +508,10 @@ Efficient decoder and encoder can be used as:
```python
from mashumaro.codecs.orjson import ORJSONDecoder, ORJSONEncoder

decoder = ORJSONDecoder(<shape_type>)
decoder = ORJSONDecoder(<shape_type>, ...)
decoder.decode(...)

encoder = ORJSONEncoder(<shape_type>)
encoder = ORJSONEncoder(<shape_type>, ...)
encoder.encode(...)
```

Expand Down Expand Up @@ -561,10 +559,10 @@ Efficient decoder and encoder can be used as:
```python
from mashumaro.codecs.yaml import YAMLDecoder, YAMLEncoder

decoder = YAMLDecoder(<shape_type>)
decoder = YAMLDecoder(<shape_type>, ...)
decoder.decode(...)

encoder = YAMLEncoder(<shape_type>)
encoder = YAMLEncoder(<shape_type>, ...)
encoder.encode(...)
```

Expand Down Expand Up @@ -624,10 +622,10 @@ Efficient decoder and encoder can be used as:
```python
from mashumaro.codecs.toml import TOMLDecoder, TOMLEncoder

decoder = TOMLDecoder(<shape_type>)
decoder = TOMLDecoder(<shape_type>, ...)
decoder.decode(...)

encoder = TOMLEncoder(<shape_type>)
encoder = TOMLEncoder(<shape_type>, ...)
encoder.encode(...)
```

Expand Down Expand Up @@ -679,10 +677,10 @@ Efficient decoder and encoder can be used as:
```python
from mashumaro.codecs.msgpack import MessagePackDecoder, MessagePackEncoder

decoder = MessagePackDecoder(<shape_type>)
decoder = MessagePackDecoder(<shape_type>, ...)
decoder.decode(...)

encoder = MessagePackEncoder(<shape_type>)
encoder = MessagePackEncoder(<shape_type>, ...)
encoder.encode(...)
```

Expand Down

0 comments on commit 7ea5de8

Please sign in to comment.