Create README.md
This commit is contained in:
parent
0c6fd957dd
commit
600219fb42
25
README.md
Normal file
25
README.md
Normal file
@ -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.
|
||||||
Loading…
Reference in New Issue
Block a user