From 3e0b70e4e7144c4261c44d924129e35da2fc2146 Mon Sep 17 00:00:00 2001
From: Hri7566 <hri7566@gmail.com>
Date: Sat, 9 Sep 2023 05:27:16 -0400
Subject: [PATCH] Update README.md

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

diff --git a/README.md b/README.md
index d307a89..4f72c29 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,52 @@
 # mpp-server-dev2
 
 This is a new MPP server currently in development for [MPP.dev](https://www.multiplayerpiano.dev). The original server is old and it needs a new one.
+
+This server uses Bun.
+
+The commit history includes BopItFreak's server because this server is (debatably) a heavy reimplementation of my fork of it.
+
+## How to run
+
+0. Install bun
+
+    ```
+    $ curl -fsSL https://bun.sh/install | bash
+    ```
+
+1. Configure
+
+    - Copy environment variables
+
+    ```
+    $ cp .env.template .env
+    ```
+
+    Edit `.env` to your needs.
+
+    - Edit the files in the `config` folder to match your needs
+
+2. Install packages
+
+    ```
+    $ bun i
+    ```
+
+3. Setup database
+
+    ```
+    $ bunx prisma generate
+    $ bunx prisma db push
+    ```
+
+4. Build
+
+    ```
+    $ bun run build
+    ```
+
+5. Run
+
+    ```
+    $ bun start
+    ```