From cb9ae923f54cdef700749a0939a0ca9d6e4ca6f1 Mon Sep 17 00:00:00 2001 From: mos Date: Sun, 4 Aug 2024 10:43:11 +0200 Subject: [PATCH] improve README --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1fa70b3..8b9f5e2 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,19 @@ bip is a library which provides a framework for parsing plain bip text and also provides faculties for serialization and deserialization via serde. -bip is a data format that is converted from a descriptive text representation to a binary -representation with memory and run-time efficiency in mind. This repository consists of two -parts (bip and bipc). +``` +Time = data hh mm ss; +ctime = { + fmt = Time 8 40 30; + desc = "current time"; +} +``` + +## bipc + +Tool for converting plain-text bip data to its binary representation. + +``` +bipc [-o outfile] +```