From 7812e2170383e2b6effe01542f3f2d14704d470a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20Kr=C3=B6ker?= Date: Sun, 2 Oct 2022 18:11:39 +0200 Subject: [PATCH] update readme --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d6491ee..4e72a25 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,9 @@ DDB.config.pretty_json_files = True # Default value You can specify your own json encoder and decoder if you need to. The standard library json module is sufficient most of the time. -However, alternatives like orjson might be more performant for your use case +However, alternatives like orjson might be more performant for your use case. +The encoder function should take a dict and return a str or bytes. +The decoder function should take a string and return a dict. ```python DDB.config.custom_json_encoder = None # Default value DDB.config.custom_json_decoder = None # Default value