From abdf81b39b3b4116ee570cc4ef1731163685c5cd Mon Sep 17 00:00:00 2001 From: Daniel Lemire Date: Fri, 19 Jul 2019 16:25:05 -0400 Subject: [PATCH] Making sure that it is clear that we generate a full DOM --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 713b61d64..e83e6d7b6 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,9 @@ This code is made available under the Apache License 2.0. Under Windows, we build some tools using the windows/dirent_portable.h file (which is outside our library code): it under the liberal (business-friendly) MIT license. -## Code example +## Code usage and example + +The main API involves populating a `ParsedJson` object which hosts a fully navigable document-object-model (DOM) view of the JSON document. The main function is `json_parse` which takes a string containing the JSON document as well as a reference to pre-allocated `ParsedJson` object (which can be reused multiple time). Once you have populated the `ParsedJson` object you can navigate through the DOM with an iterator (e.g., created by `ParsedJson::iterator pjh(pj)`, see 'Navigating the parsed document'). ```C #include "simdjson/jsonparser.h"