From 673c344ff43086a665726edd56009edf7432eee7 Mon Sep 17 00:00:00 2001
From: Hydroxycarbamide <siklos@tuta.io>
Date: Sun, 20 Oct 2024 17:05:36 +0200
Subject: [PATCH] Update readme.md

---
 README.md | 36 +++++++++++++++++++-----------------
 1 file changed, 19 insertions(+), 17 deletions(-)

diff --git a/README.md b/README.md
index 3c222e7..68cc221 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,27 @@
-# startpage
-My startpage, edited from github.com/kencx
+<div align="center">
+    <img src="https://user-images.githubusercontent.com/76164598/170824479-5918fe82-18df-4549-8b20-c2b1595a27d0.png" alt="" align="center" />
+    <h1 align="center">Startpage</h1>
+</div>
 
-# How to use?
+# Getting Started
 
-1. git clone this repo
-2. copy the path to the index.html file
-3. set the path as your default startpage in your desired browser
+## Using bun.sh
 
-# Customization
+```
+bun start
+```
 
-### Image(s)
-i have included a few vaporwave/retro styled gifs in this repo, you can edit it on the line <b>22</b> in the index.html the ```src="clouds.gif"``` to something like ```src="plane.gif"``` or your own image/gif
+## Using docker-compose
 
-### URLs
-you can edit all of the URLs to your desired, starting on line **44** in ```index.html```
-<br> **Example:** <br>
-**line 45:** ```<li><a href="https://github.com/">github</a></li>``` <br >can be changed to <br> **line 45:** ```<li><a href="https://yoururl.com/">your url</a></li>```
+```
+docker-compose up --build
+```
 
-### Categories
+# Customize
 
-i think you get it, starting on line **44** you can change the names of the categories etc. etc. i believe you're not dumb and understand
+Everything is static, just modify the content as you want in `src/` or `assets`.
 
-# Screenshot
-![image](https://user-images.githubusercontent.com/76164598/170824479-5918fe82-18df-4549-8b20-c2b1595a27d0.png)
+# Contributors
+
+- [Siklos/Hydroxycarbamide](https://git.siklos-chaneru.dev/Siklos)
+- [Woox](https://github.com/nwvh)