From 4a754036826405dd488b0718315b434c9cb726d0 Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Sun, 9 Dec 2018 21:29:09 +0100 Subject: doc: outline usage --- readme.rst | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'readme.rst') diff --git a/readme.rst b/readme.rst index a51b7e9..1337387 100644 --- a/readme.rst +++ b/readme.rst @@ -5,6 +5,13 @@ format. Includes a utility ``sidparse`` for dissecting SIDs on the command line. +entry points +------------ + +Convert to and from the string format using the *to_string* and *of_string* +functions. The binary representations can be encoded and decoded using the +corresponding *to_bytes* and *of_bytes* methods. + building -------- The main build system is Oasis_, but there is a wrapper for OPAM to simplify -- cgit v1.2.3