README.md in oj-1.4.7 vs README.md in oj-2.0.0
- old
+ new
@@ -30,14 +30,16 @@
*Fast XML parser and marshaller on GitHub*: https://github.com/ohler55/ox
## <a name="release">Release Notes</a>
-### Release 1.4.7
+### Release 2.0.0
- - In compat mode non-String keys are converted to Strings instead of raising and error. (issue #52)
+ - Thanks to yuki24 Floats are now output with a decimal even if they are an integer value.
+ - <b>The Simple API for JSON (SAJ) API has been added. Read more about it on the [Oj::Saj page](http://www.ohler.com/oj/Oj/Saj.html).</b>
+
## <a name="description">Description</a>
Optimized JSON (Oj), as the name implies was written to provide speed
optimized JSON handling. It was designed as a faster alternative to Yajl and
other the common Ruby JSON parsers. So far is has achieved that at about 2
@@ -68,9 +70,18 @@
fixed and there is at least one that has caused a test to be commented out for JRuby in the Oj test suite. JRuby can be
build with extensions enabled. Check the documenation for JRuby installs in your environment.
Oj is also compatible with Rails. Just make sure the Oj gem is installed and
[multi_json](https://github.com/intridea/multi_json) will pick it up and use it.
+
+Oj offers two alternative APIs for processing JSON. The fastest one is the Oj::Doc API. The Oj::Doc API takes a
+completely different approach by opening a JSON document and providing calls to navigate around the JSON while it is
+open. With this approach JSON access can be well over 20 times faster than conventional JSON parsing.
+
+Another API, the Oj::Saj API follows an XML SAX model and walks the JSON document depth first and makes callbacks for
+each element. The Oj::Saj API is useful when only portions of the JSON are of interest. Performance up to 20 times
+faster than conventional JSON are possible. The API is simple to use but does require a different approach than the
+conventional parse followed by access approach used by conventional JSON parsing.
## <a name="compare">Comparisons</a>
### Fast Oj::Doc parser comparisons