From 682194d3f3ff72d46849a37b2b2b7eef73787d6f Mon Sep 17 00:00:00 2001 From: Kaustubh Maske Patil <37668193+nikochiko@users.noreply.github.com> Date: Sat, 20 Jul 2024 04:09:20 +0530 Subject: [PATCH] Add installation and license section to README --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c33d1e1..76848c5 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ $ boks moo To put multiple things in connected boxes, -``` +```shell $ boks apps dbms data +----------+ +----------+ +----------+ | apps |<--->| dbms |<--->| data | @@ -23,3 +23,16 @@ $ boks apps dbms data ``` Use `-a` to customize length of arrows, `-p` to customize padding. + +## Installation + +If you have `dune` installed, + +```shell +$ git clone https://github.com/nikochiko/boks && cd boks +$ dune install +``` + +## License + +MIT. See [LICENSE](/LICENSE).