aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Pulford <mark@kyne.com.au>2011-11-29 00:11:22 +1030
committerMark Pulford <mark@kyne.com.au>2011-11-29 00:11:22 +1030
commit8e259a73fd2fbf9060e3514cd67eee69ebfb85a7 (patch)
treefd004f416f75385f1dd06bdca2d3e14621a7284a
parent11b35407875cc363f7897ff1c7c34828b4efe3ce (diff)
downloadlua-cjson-8e259a73fd2fbf9060e3514cd67eee69ebfb85a7.tar.gz
lua-cjson-8e259a73fd2fbf9060e3514cd67eee69ebfb85a7.tar.bz2
lua-cjson-8e259a73fd2fbf9060e3514cd67eee69ebfb85a7.zip
Improve README documentation (minor)
-rw-r--r--README21
1 files changed, 10 insertions, 11 deletions
diff --git a/README b/README
index 09caab5..13e5a03 100644
--- a/README
+++ b/README
@@ -15,9 +15,8 @@ Features:
15 15
16Caveats: 16Caveats:
17- UTF-16 and UTF-32 are not supported. 17- UTF-16 and UTF-32 are not supported.
18- Multiple OS threads within a single Lua state are not currently 18- Multi-threading within a single Lua state is not supported.
19 supported. However, this is an extremely uncommon configuration due 19 However, this is not a recommended configuration under Lua.
20 to performance limitations.
21 20
22To obtain the latest version of Lua CJSON visit: 21To obtain the latest version of Lua CJSON visit:
23 22
@@ -266,15 +265,15 @@ not freed until CJSON is garbage collected. Setting this option to
266cjson.encode(). 265cjson.encode().
267 266
268 267
269Lua / JSON limitations and CJSON 268JSON and handling under Lua CJSON
270================================ 269=================================
271 270
272Null handling 271Nulls
273------------- 272-----
274 273
275Lua CJSON decodes JSON "null" as a Lua lightuserdata NULL pointer. 274Lua CJSON decodes JSON "null" as a Lua lightuserdata NULL pointer.
276 275
277CJSON provides "cjson.null" as a convenience for comparison. 276As a convenience, "cjson.null" is provided for comparison.
278 277
279 278
280Table keys 279Table keys
@@ -296,7 +295,7 @@ Metamethods
296 295
297Lua CJSON does not use metamethods when serialising tables. 296Lua CJSON does not use metamethods when serialising tables.
298- next() is used to iterate over tables. 297- next() is used to iterate over tables.
299- rawget() is used when iterating over arrays. 298- rawget() is used to iterate over arrays.
300 299
301 300
302Functions, Userdata, Threads 301Functions, Userdata, Threads
@@ -306,8 +305,8 @@ Lua CJSON will generate an error if asked to serialise Lua functions,
306userdata, lightuserdata or threads. 305userdata, lightuserdata or threads.
307 306
308 307
309Locale handling 308Locales
310--------------- 309-------
311 310
312Lua CJSON uses strtod() and snprintf() to perform numeric conversion 311Lua CJSON uses strtod() and snprintf() to perform numeric conversion
313as they are usually well supported, fast and bug free. 312as they are usually well supported, fast and bug free.