update CHANGELOG.md and README.md

1ma · Aug 2, 2019 · 8c37b26 · 8c37b26
1 parent 09325e1
commit 8c37b26
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+### [2.1.0] - 2019-08-02
+
+  * (Feature) Transparently decode Json payloads with the [simdjson](https://github.com/crazyxman/simdjson_php) PHP bindings when they are available.
+
 ### [2.0.0] - 2018-12-05
 
   * (Breaking Change) Made `Middleware::__invoke()` type safe by passing a `Procedure` instead of `callable` as the second parameter. Requires a typehint rewrite in all descendants.
@@ -22,6 +26,7 @@
 
   * Initial pre-release
 
+[2.1.0]: https://github.com/1ma/JsonRpc/compare/v2.0.0...v2.1.0
 [2.0.0]: https://github.com/1ma/JsonRpc/compare/v1.0.0...v2.0.0
 [1.0.0]: https://github.com/1ma/JsonRpc/compare/v0.9.0...v1.0.0
 [0.9.0]: https://github.com/1ma/JsonRpc/commit/081b048bb5a5a58235953dd42772ff31256a9e49
diff --git a/README.md b/README.md
@@ -12,6 +12,7 @@ A modern, object-oriented [JSON-RPC 2.0] server for PHP 7.1 featuring JSON Schem
 	- [Creating Procedures](#creating-procedures)
 	- [Registering Services](#registering-services)
 	- [Running the Server](#running-the-server)
+- [Json Parsing](#json-parsing)
 - [Concurrent Server](#concurrent-server)
 - [Middlewares](#middlewares)
 	- [Middleware guarantees](#middleware-guarantees)
@@ -176,6 +177,15 @@ $response = $server->run('{"jsonrpc":"2.0","method":"add","params":[2,3],"id":1}
 ```
 
 
+## Json Parsing
+
+The library will try to decode Json payloads using the [simdjson PHP bindings] if they are available. When not
+available the builtin `json_decode()` function will be used instead.
+
+These bindings integrate a [C++ Json decoder] written by Daniel Lemire into PHP. In the synthetic benchmarks bundled
+with the extension it shows speedups ranging between 1.4x and 2x compared to `json_decode()`.
+
+
 ## Concurrent Server
 
 `UMA\JsonRpc\ConcurrentServer` has the same API as the regular `Server`, but it is an abomination than whenever
@@ -415,6 +425,8 @@ $response = $server->run('[
 
 
 [JSON-RPC 2.0]: http://www.jsonrpc.org/specification
+[simdjson PHP bindings]: https://github.com/crazyxman/simdjson_php
+[C++ Json decoder]: https://github.com/lemire/simdjson
 [PCNTL extension]: http://php.net/manual/en/intro.pcntl.php
 [Slim framework documentation]: https://www.slimframework.com/docs/
 [avian carriers]: https://tools.ietf.org/html/rfc1149