Skip to content

Commit abdf81b

Browse files
lemirelemire
authored
Making sure that it is clear that we generate a full DOM
1 parent 1176725 commit abdf81b

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,9 @@ This code is made available under the Apache License 2.0.
6565

6666
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.
6767

68-
## Code example
68+
## Code usage and example
69+
70+
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').
6971

7072
```C
7173
#include "simdjson/jsonparser.h"

0 commit comments

Comments
 (0)