hare

commit 11246a9b286ca851530ba9ae1998289f4cfbf83b
parent b0f5261dd76523630ae5c35c08c147b2eb603de3
Author: Drew DeVault <sir@cmpwn.com>
Date:   Wed, 11 May 2022 14:08:51 +0200

encoding::json: add README

Diffstat:
A
encoding/json/README
 | 
11
+++++++++++

1 file changed, 11 insertions(+), 0 deletions(-)
diff --git a/encoding/json/README b/encoding/json/README
@@ -0,0 +1,11 @@
+This module provides an implementation of the JavaScript Object Notation (JSON)
+format, defined by RFC 7159. A lexer for JSON values is provided, which may be
+initialized with [[lex]] and provides tokens via [[next]], and which uses a
+relatively small amount of memory and provides relatively few gurantees
+regarding the compliance of the input with the JSON grammar.
+
+Additionally, the [[value]] type is provided to store any value JSON value, as
+well as helpers like [[newobject]], [[get]], and [[set]]. One can load a JSON
+value from an input stream into a heap-allocated [[value]] via [[load]], which
+enforces all of JSON's grammar constraints and returns an object which must be
+freed with [[finish]].