1Collatejson library, written in golang, provides encoding and decoding function
2to transform JSON text into binary representation without loosing information.
3That is,
4
5* binary representation should preserve the sort order such that, sorting
6  binary encoded json documents much match sorting by functions that parse
7  and compare JSON documents.
8* it must be possible to get back the original document, in semantically
9  correct form, from its binary representation.
10
11Notes:
12
13* items in a property object are sorted by its property name before they
14  are compared with other property object.
15
16for api documentation and bench marking try,
17
18.. code-block:: bash
19
20    godoc github.com/couchbaselabs/go-collatejson | less
21    cd go-collatejson
22    go test -test.bench=.
23
24to measure relative difference in sorting 100K elements using encoding/json
25library and this library try,
26
27.. code-block:: bash
28
29    go test -test.bench=Sort
30
31examples/* contains reference sort ordering for different json elements.
32
33For known issues refer to `TODO.rst`
34