Adding some very minor documentation
[ton] / README.rst
1 TON: Twofold Object Notation
2 ============================
3
4 TON is a twofold object notation with equivalent binary and human-readable
5 forms. The binary form is optimized for speed and size, while the human-
6 readable form is designed to be easy-to-understand. Every TON object in binary
7 representation has one unambiguously equivalent TON string representation
8 (ignoring whitespace), and every TON object in string representation has one
9 unambiguously equivalent TON binary representation. This means that you can
10 use the binary representation and get all the benefits of binary, but if you
11 need to inspect the contents of the binary it's simple to convert it to the
12 string notation and get all the benefits of a human-readable representation.
13
14 Without further ado, here's what the human-readable representation looks like:::
15
16     {
17       'foo'utf8: 1i8,
18       'bar'utf8: 'baz'utf16,
19       'qux'utf8: [1i16, -1i16],
20       'quux'utf8: [2i32, -2i32],
21       'quuz'utf8: [3i64, -3i64]
22     }