summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README12
1 files changed, 5 insertions, 7 deletions
diff --git a/README b/README
index f679136..22249ba 100644
--- a/README
+++ b/README
@@ -11,13 +11,11 @@ will be two variants available:
generated by the ragel state machine compiler
http://www.cs.queensu.ca/~thurston/ragel .
-Both variants of the JSON generator escape all non-ASCII and control characters
-with \uXXXX escape sequences, and support UTF-16 surrogate pairs in order to be
-able to generate the whole range of unicode code points. This means that
-generated JSON document is encoded as UTF-8 (because ASCII is a subset of
-UTF-8) and at the same time avoids decoding problems for receiving endpoints,
-that don't expect UTF-8 encoded texts. On the negative side this may lead to a
-bit longer strings than necessarry.
+Both variants of the JSON generator generate UTF-8 character sequences by
+default. If an :ascii_only option with a true value is given, they escape all
+non-ASCII and control characters with \uXXXX escape sequences, and support
+UTF-16 surrogate pairs in order to be able to generate the whole range of
+unicode code points.
All strings, that are to be encoded as JSON strings, should be UTF-8 byte
sequences on the Ruby side. To encode raw binary strings, that aren't UTF-8