From fbb108724cf0b7243f186cd638131a0a90f93f5d Mon Sep 17 00:00:00 2001
From: 1e99 <noemail@noemail>
Date: Mon, 16 Dec 2024 17:07:07 +0100
Subject: [PATCH] readme

---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..52779e2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# PixelChat
+[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/NuGxJKtDKS)
+
+A simple Minecraft Mod to make the in-game chat awesome!
+
+## Features
+- Image Sharing: Drag and drop image files into the chat and share them in chat.
+
+## Fabric Setup
+1. Install Fabric: Ensure that you have Fabric installed.
+2. Download PixelChat: Get the latest version from the [releases](https://git.1e99.eu/1e99/pixelchat/releases) tab.
+3. Add to mods folder: Place the downloaded JAR file into your mods folder.
+
+### Configuration
+A configuration file can be found at
+```json
+{
+  // Set where images will be uplaoded to
+  // You must omit the '/' at the end of the URL
+  // This must be a PixelChat server (See later on how to set one up yourself)
+  "image_hosts": [
+    "https://pc.1e99.eu"
+  ]
+}
+```
+
+## Server Setup
+Setting up a PixelChat server can be done with docker compose or from source.
+
+### Docker Compose
+```yml
+services:
+  "pixelchat":
+    build: "https://git.1e99.eu/1e99/pixelchat.git"
+    ports:
+      - "3000:3000"
+```
+
+### From Source
+WIP