From 85a9cd768b575630b5a6c2f5471d766fb71d3516 Mon Sep 17 00:00:00 2001 From: David Kerkeslager Date: Wed, 3 May 2017 23:09:20 -0400 Subject: [PATCH] Adding some very minor documentation --- README.rst | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 4a841d6..bb854ee 100644 --- a/README.rst +++ b/README.rst @@ -1 +1,22 @@ -# TON: Twofold Object Notation +TON: Twofold Object Notation +============================ + +TON is a twofold object notation with equivalent binary and human-readable +forms. The binary form is optimized for speed and size, while the human- +readable form is designed to be easy-to-understand. Every TON object in binary +representation has one unambiguously equivalent TON string representation +(ignoring whitespace), and every TON object in string representation has one +unambiguously equivalent TON binary representation. This means that you can +use the binary representation and get all the benefits of binary, but if you +need to inspect the contents of the binary it's simple to convert it to the +string notation and get all the benefits of a human-readable representation. + +Without further ado, here's what the human-readable representation looks like::: + + { + 'foo'utf8: 1i8, + 'bar'utf8: 'baz'utf16, + 'qux'utf8: [1i16, -1i16], + 'quux'utf8: [2i32, -2i32], + 'quuz'utf8: [3i64, -3i64] + } -- 2.20.1