diff --git a/README.md b/README.md new file mode 100644 index 0000000..4818d0c --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +json-pull +========= + +A streaming JSON pull parser in C. + +Does the world really need another JSON parser? Maybe not. +But what distinguishes this one is the desire to let you +read through gigantic files larger than you can comfortably +fit in memory and still find the parts you need. + +Setup +----- + +You can create a json_pull parser object +by calling json_begin_file() to begin reading from a file +or json_begin_string() to begin reading from a string. + +You can also read from anything you want by calling json_begin() +with your own read() and peek() functions that +return or preview, respectively, the next UTF-8 byte from your input stream. +