From 1115d77d0b246ead7bf0b258980e3f302c308924 Mon Sep 17 00:00:00 2001
From: jabuxas <jabuxas@proton.me>
Date: Tue, 11 Feb 2025 00:36:54 -0300
Subject: [PATCH] docs: update readme

---
 readme.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..c57aa74
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,44 @@
+# refinement
+
+hii, this is my personal site built with [rocket](https://rocket.rs) and rust. it's dockerized for easy deployment.
+
+## quick start
+
+### running locally
+
+1. clone the repo:
+
+   ```bash
+   git clone https://github.com/jabuxas/refinement.git
+   cd refinement
+   ```
+
+2. run the site:
+
+   ```bash
+   cargo run
+   ```
+
+3. open your browser at http://127.0.0.1:8000
+
+### running with docker
+
+- this setup maps container port 8000 to host port 8880.
+
+- build the image:
+
+  ```bash
+  docker build -t refinement .
+  ```
+
+- run the container:
+
+      docker run -p 8880:8000 refinement
+
+- or use docker-compose:
+
+  ```bash
+    docker-compose up -d
+  ```
+
+- open your browser at http://localhost:8880