From 1d4ab4a54fda8a2dd07476f3a13a06bf71a09ad5 Mon Sep 17 00:00:00 2001
From: Alex Clarke <alex.j.tusa@gmail.com>
Date: Mon, 18 Nov 2024 18:17:21 -0700
Subject: [PATCH] chore: updated the README

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/README.md b/README.md
index c90cab2..909dfd8 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,32 @@
 # ClaSH
 The ClaSH shell for my personal website
+
+## Building
+To build the ClaSH shell, run the following command:
+```shell
+cargo build --release
+```
+
+## Running
+To run the ClaSH shell, you can do the following:
+
+### Run the debug executable
+```shell
+cargo run
+```
+
+### Run the release executable
+```shell
+./target/release/clash
+```
+
+### Run the container
+```shell
+docker build -t clash .
+docker run --rm -it -p 7681:7681 clash
+```
+
+### Run the container using docker-compose
+```shell
+docker compose up
+```