Skip to content

Commit 95f2948

Browse files
authored
Improve documentation
1 parent cc861f5 commit 95f2948

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,23 @@
11
# NeoUniversalBinaryJSON
22
An implementation of Universal Binary JSON (UBJSON) for Pharo.
33

4-
Universal Binary JSON (UBJSON) is a computer data interchange format. It is a binary form directly imitating JSON, but requiring fewer bytes of data. It aims to achieve the generality of JSON, combined with being easier and more efficient to process than JSON. The size/speed/efficiency differences are minor though, especially compared with compacted JSON. The implementation is simpler, though.
4+
Universal Binary JSON (UBJSON) is a computer data interchange format. It is a binary form directly imitating JSON, but requiring fewer bytes of data. It aims to achieve the generality of JSON, combined with being easier and more efficient to process than JSON.
5+
6+
The size/speed/efficiency differences are minor for typical JSON payloads, especially compared with compacted JSON. The implementation is simpler, though, as there is no string escaping and no number parsing.
7+
8+
UBJSON is making a larger difference when dealing with arrays containing numbers. Especially with ByteArrays, BJSON makes a huge difference, since these are essentially stored natively.
59

610
See also
711

812
- http://ubjson.org
913
- https://en.wikipedia.org/wiki/UBJSON
1014

15+
## Usage
16+
17+
NeoUBJSONReader reads/parses a Universal Binary JSON stream. Use #on: to initialize it on a binary read stream and decode a value using #next. Its class side #fromByteArray: is convenient too.
18+
19+
NeoUBJSONWriter writes/generates a Universal Binary JSON stream. Use #on: to initialize it on a binary write stream and encode a value using #nextPut:. Its class side #toByteArray: is convenient too.
20+
1121
## Installation
1222

1323
This is a [Pharo Smalltalk](http://wwww.pharo.st) project

0 commit comments

Comments
 (0)