From 80ef3dd6b2458e2a7a002b76653b45b5462e7aa3 Mon Sep 17 00:00:00 2001 From: Michiel Borkent Date: Fri, 9 Aug 2019 19:58:11 +0200 Subject: [PATCH] doc --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 130f0842..e6bfe6d1 100644 --- a/README.md +++ b/README.md @@ -46,11 +46,20 @@ You may also download a binary from [Github](https://github.com/borkdude/babashk ## Usage -The first argument to `bb` is the form to be executed. There is one special -variable, `*in*` which is EDN that is piped from stdin. +``` shellsession +echo | bb [--raw] '' +``` -If the first argument is `--version`, then `bb` will print the version and exit. -If the first argument is `--raw`, then `bb` will interpret stdin as string input. +There is one special variable, `*in*` is piped from stdin. When the `--raw` flag +is provided, `*in*` is a single string or vector of strings. When it is omitted, +the input is read as EDN. + +The current version can be printed with: + +``` shellsession +bb --version +0.0.2 +``` Examples: