Create README.md

This commit is contained in:
Kaustubh Maske Patil 2024-07-20 04:03:22 +05:30 committed by GitHub
parent 0c6fd957dd
commit 600219fb42
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

25
README.md Normal file
View 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.