From 600219fb427bee419a0a2b62ecb8055e48069761 Mon Sep 17 00:00:00 2001
From: Kaustubh Maske Patil <37668193+nikochiko@users.noreply.github.com>
Date: Sat, 20 Jul 2024 04:03:22 +0530
Subject: [PATCH] Create README.md

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 README.md

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.