From 016e85e1ff3e7a12c57eef4a98f72de1605927ee Mon Sep 17 00:00:00 2001 From: flamendless Date: Wed, 20 May 2020 08:36:37 +0800 Subject: [PATCH] Updated README --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7534e63..932e5d4 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,6 @@ A library-companion to register custom data types that can be encoded and decoded for [json.lua](https://github.com/rxi/json.lua). -## Why Arson? - -It is from `RSON`, which is derived from `Register-JSON`. I know it does not make any sense. But is sounds cool. ## How to use: @@ -28,7 +25,7 @@ local my_custom_class = { ## API -* Arson.register - register your own custom data/class that can be encoded and decoded +* **Arson.register** - register your own custom data/class that can be encoded and decoded Example: ```lua @@ -45,7 +42,7 @@ arson.register("custom_vec2_class", ``` --- -* Arson.unregister - unregister an already added custom data/class +* **Arson.unregister** - unregister an already added custom data/class Example: ```lua @@ -57,7 +54,7 @@ arson.unregister("custom_vec2_class") ``` --- -* Arson.encode - encode a table +* **Arson.encode** - encode a table Example: ```lua @@ -85,7 +82,7 @@ local str_json = json.encode(custom_data) ``` --- -* Arson.decode - decode a table. It will modify the table passed as it will replace custom data with the decoded one +* **Arson.decode** - decode a table. It will modify the table passed as it will replace custom data with the decoded one Example: ```lua @@ -100,6 +97,10 @@ arson.decode(json_decoded) ``` --- +## Why Arson? + +It is from `RSON`, which is derived from `Register-JSON`. I know it does not make any sense. But is sounds cool. + ## LICENSE See MIT License [file here](https://github.com/flamendless/arson.lua/blob/master/LICENSE)