diff --git a/README.md b/README.md index a8efcbd..b8e3f4b 100644 --- a/README.md +++ b/README.md @@ -63,24 +63,25 @@ Similar to `pcall` and `loadstring` calls, `load` returns status as the first va ## Options -* indent (string) -- indentation; triggers long multi-line output -* comment (true/false/maxlevel) -- provide stringified value in a comment (up to `maxlevel` of depth) -* sortkeys (true/false/function) -- sort keys -* sparse (true/false) -- force sparse encoding (no nil filling based on `#t`) -* compact (true/false) -- remove spaces -* fatal (true/False) -- raise fatal error on non-serilizable values -* nocode (true/False) -- disable bytecode serialization for easy comparison -* nohuge (true/False) -- disable checking numbers against undefined and huge values -* maxlevel (number) -- specify max level up to which to expand nested tables -* maxnum (number) -- specify max number of elements in a table -* maxlength (number) -- specify max length for all table elements -* numformat (string; "%.17g") -- specify format for numeric values (shortest possible round-trippable double) -* valignore (table) -- allows to specify a list of values to ignore (as keys) -* keyallow (table) -- allows to specify the list of keys to be serialized. Any keys not in this list are not included in final output (as keys) +* indent (string) -- indentation; triggers long multi-line output. +* comment (true/false/maxlevel) -- provide stringified value in a comment (up to `maxlevel` of depth). +* sortkeys (true/false/function) -- sort keys. +* sparse (true/false) -- force sparse encoding (no nil filling based on `#t`). +* compact (true/false) -- remove spaces. +* fatal (true/False) -- raise fatal error on non-serilizable values. +* nocode (true/False) -- disable bytecode serialization for easy comparison. +* nohuge (true/False) -- disable checking numbers against undefined and huge values. +* maxlevel (number) -- specify max level up to which to expand nested tables. +* maxnum (number) -- specify max number of elements in a table. +* maxlength (number) -- specify max length for all table elements. +* numformat (string; "%.17g") -- specify format for numeric values (shortest possible round-trippable double). +* valignore (table) -- allows to specify a list of values to ignore (as keys). +* keyallow (table) -- allows to specify the list of keys to be serialized. +Any keys not in this list are not included in final output (as keys). * keyignore (table) -- allows to specity the list of keys to ignore in serialization. -* valtypeignore (table) -- allows to specify a list of value *types* to ignore (as keys) -* custom (function) -- provide custom output for tables -* name (string) -- name; triggers full serialization with self-ref section +* valtypeignore (table) -- allows to specify a list of value *types* to ignore (as keys). +* custom (function) -- provide custom output for tables. +* name (string) -- name; triggers full serialization with self-ref section. These options can be provided as a second parameter to Serpent functions.