From 5492c5da1be8fd2d7b77c87a84783d0b802c1d94 Mon Sep 17 00:00:00 2001
From: Luna <lsaak@byte5.de>
Date: Sun, 18 Feb 2024 22:38:17 +0100
Subject: [PATCH] chore(readme): create selfhosting guide

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

diff --git a/README.md b/README.md
index e69de29..3d32766 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,31 @@
+# web-expl
+
+Explore the internet in 3-dimensional space.
+Built with NextJS, TailwindCSS and ThreeJS.
+
+## Demo
+You can try out the live demo [here](https://web-expl.qwq.sh).
+
+![Visualizer](./assets/screenshot.png)
+
+## Deployment
+
+You can selfhost `web-expl` using Docker.
+To deploy the scraper, run:
+
+```bash
+  docker run -p <OUTGOING_PORT>:3000 --restart=always --name web-expl ghcr.io/angelsflyinhell/web-expl
+```
+
+## Installation
+
+Install `web-expl` with npm:
+
+```bash
+  gh repo clone angelsflyinhell/web-expl
+  cd web-expl
+
+  npm install
+
+  npm run dev
+```