updated README.md

Author: FourierTransformer

README.md

@@ -1,16 +1,19 @@
-# lua-simdjson
-A basic lua binding to [simdjson](https://simdjson.org). The simdjson library is an incredibly fast JSON parser that uses SIMD instructions and fancy algorithms to parse JSON very quickly. It's been tested with LuaJIT 2.0/2.1 and Lua 5.1, 5.2, and 5.3 on linux
+# lua-simdjson (WIP)
+[![Build Status](https://travis-ci.org/FourierTransformer/lua-simdjson.svg?branch=master)](https://travis-ci.org/FourierTransformer/lua-simdjson)
+
+A basic lua binding to [simdjson](https://simdjson.org). The simdjson library is an incredibly fast JSON parser that uses SIMD instructions and fancy algorithms to parse JSON very quickly. It's been tested with LuaJIT 2.0/2.1 and Lua 5.1, 5.2, 5.3, and 5.4 on linux/osx. It has a general parsing mode and a lazy mode that uses a JSON pointer.
 
 Current simdjson version: 0.3.1
 
 ## Requirements
  * lua-simdjson only works on 64bit systems.
- * a modern lua build environment with g++ and support for C++11
+ * a lua build environment with support for C++11
+   * g++ version 7+ and clang++ version 6+ or newer should work!
 
 ## Parsing
 There are two main ways to parse JSON in lua-simdjson:
  1. With `parse`: this parses JSON and returns a lua table with the parsed values
- 2. With `open`: this reads in the JSON and keeps it in simdjson's internal format. It can then be accessed using a JSON pointer (examples below)
+ 2. With `open`: this reads in the JSON and keeps it in simdjson's internal format. The values can then be accessed using a JSON pointer (examples below)
 
 Both of these methods also have support to read files on disc with `parseFile` and `openFile` respectively. If handling JSON from disk, these methods should be used and are incredibly fast.
 
@@ -40,7 +43,7 @@ local response = simdjson.parse([[
     }
 }
 ]])
-print(response["Images"]["Width"])
+print(response["Image"]["Width"])
 
 -- OR to parse a file from disk
 local fileResponse = simdjson.parseFile("jsonexamples/twitter.json")
@@ -52,7 +55,7 @@ print(fileResponse["statuses"][1]["id"])
 The `open` methods currently require the use of a JSON pointer, but are very quick.
 ```lua
 local simdjson = require("simdjson")
-local response = simdjson.parse([[
+local response = simdjson.open([[
 { 
     "Image": {
         "Width":  800,
@@ -68,30 +71,32 @@ local response = simdjson.parse([[
     }
 }
 ]])
-print(response.at("Images/Width"))
+print(response:at("Image/Width"))
 
 -- OR to parse a file from disk
-local fileResponse = simdjson.parseFile("jsonexamples/twitter.json")
-print(fileResponse.at("statuses/0/id") --using a JSON pointer
+local fileResponse = simdjson.open("jsonexamples/twitter.json")
+print(fileResponse:at("statuses/0/id")) --using a JSON pointer
 
 ```
 The `open` and `parse` codeblocks should print out the same values. It's worth noting that the JSON pointer indexes from 0.
 
 This lazy style of using the simdjson data structure could also be used with array access in the future, and would result in ultra-fast JSON parsing.
 
+## Error Handling
+lua-simdjson will error out with any errors from simdjson encountered while parsing. They are very good at helping identify what has gone wrong during parsing.
+
 ## Benchmarks
 TODO: add some benchmarks
 
-## Caveats
- * there is no encoding/dumping a lua table to JSON (yet!)
- * it only works on 64 bit systems (possibly only Linux, more testing is needed)
+## Caveats & Alternatives
+ * there is no encoding/dumping a lua table to JSON (yet! Most other lua JSON libraries can handle this)
+ * it only works on 64 bit systems (untested on Windows...)
  * it builds a large binary. On a modern linux system, it ended up being \~200k (lua-cjson comes in at 42k)
- * since it's an external module, it's not quite as easy to just grab the file and go.
- * it needs a compiler that supports at least C++11
+ * since it's an external module, it's not quite as easy to just grab the file and go (dkjson has you covered here!)
 
-## Error Handling
-lua-simdjson will error out with any errors from simdjson encountered while parsing. They are fairly informative as to what has gone wrong during parsing.
+## Philosophy
+I plan to keep it fairly inline with what the original simdjson library is capable of doing, which really means not adding too many additional options. The big _thing_ that's missing so far is encoding a lua table to JSON. I may add in an encoder at some point (likely modified from an existing lua library). There are some rumours that simdjson _may_ support creating JSON structure in the future. If that happens, I would likely switch to it. 
 
 ## Licenses
  * The jsonexamples, src/simdjson.cpp, src/simdjson.h are unmodified from the released version simdjson under the Apache License 2.0.
- * All other files/folders are apart of lua-cjson also under the Apache License 2.0.
+ * All other files/folders are apart of lua-simdjson also under the Apache License 2.0.