diff --git a/README.md b/README.md new file mode 100644 index 0000000..c33d1e1 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# boks + +CLI for making ASCII boxes with text in OCaml. + +## Usage + +To put something in a box, + +```shell +$ boks moo ++---------+ +| moo | ++---------+ +``` + +To put multiple things in connected boxes, + +``` +$ boks apps dbms data ++----------+ +----------+ +----------+ +| apps |<--->| dbms |<--->| data | ++----------+ +----------+ +----------+ +``` + +Use `-a` to customize length of arrows, `-p` to customize padding.