From 4fd9934232227e8a23f48943af6f2b1b5c74a6e7 Mon Sep 17 00:00:00 2001 From: Lorenzo Cogotti Date: Wed, 10 Aug 2022 09:25:47 +0200 Subject: [PATCH] [README] Update library name, improve ldoc documentation. --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b5521d4..dc7fd76 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -serialize - A brainless Lua table serializer +df-serialize - A brainless Lua table serializer ============================================ -**serialize** provides two functions: +**df-serialize** provides two functions: * `pack()` packs Lua tables to string. * `unpack()` unpacks a string back to a Lua table. @@ -9,7 +9,7 @@ serialize - A brainless Lua table serializer The implementation strives to be useful under the majority of reasonable use cases, to be compact, understandable and sufficiently fast. There is no pretense of complete generality, nor of absolute efficiency. -In case **serialize** does not meet exactly your requirements, the code +In case **df-serialize** does not exactly meet your requirements, its code should be immediate enough to tweak to your needs. Documentation @@ -23,6 +23,10 @@ Documentation may be generated running the command: ldoc init.lua ``` +`ldoc` generates a `doc` directory, open `doc/index.html` +with your favorite browser to read the documentation. + + Test suite ==========