From aa515c02947b5814fcdf2abc122fcdd978a0ce3a Mon Sep 17 00:00:00 2001
From: Aidan <aidan@p0ntus.com>
Date: Thu, 23 Jan 2025 19:20:22 -0500
Subject: [PATCH] add docs for dev server

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

diff --git a/README.md b/README.md
index 38a2467..17431e9 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,28 @@
 # web
 
 LibreCloud's website
+
+## Dev Server Instructions
+
+1. **Install Bun if you haven't already**
+
+   Bun is a fast JavaScript runtime, and is much faster than `npm`. These instructions will be written for Bun, but could be adapted to `npm` or `yarn` if needed.
+
+2. **Clone the repo**
+
+   ```bash
+   git clone https://git.pontusmail.org/LibreCloud/web.git
+   cd web
+   ```
+
+3. **Install dependencies**
+
+   ```bash
+   bun install
+   ```
+
+4. **Start dev server**
+
+   ```bash
+   bun dev
+   ```