summaryrefslogtreecommitdiff
path: root/README.md
blob: 913a12d11040fd38aeceb88c732724d3c792da7c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
Biniou
======

Biniou (pronounced "be new") is a binary data format designed for speed,
safety, ease of use and backward compatibility as protocols evolve.
Biniou is vastly equivalent to JSON in terms of functionality but allows
implementations several times faster (4 times faster than
[yojson](https://github.com/ocaml-community/yojson)), with
25-35% space savings.

Biniou data can be decoded into human-readable form without knowledge
of type definitions except for field and variant names which are
represented by 31-bit hashes. A program named `bdump` is provided for
routine visualization of biniou data files.

The program [atdgen](https://atd.readthedocs.io/)
is used to derive OCaml-Biniou serializers and
deserializers from type definitions.

Biniou format specification: [biniou-format.txt](biniou-format.txt)