From 99591a71912747575a8754903a81c08ec7b0d3b1 Mon Sep 17 00:00:00 2001
From: "Gu://em_" <guillem.george@epita.fr>
Date: Mon, 10 Mar 2025 10:49:03 +0100
Subject: [PATCH] Added README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bf8cf1b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# WF radio
+
+## ⚠ Warning: this project isn't even in alpha yet
+Everything is still in WIP so don't expect it to work yet.
+
+## About
+WF radio is an open source platform for your mods, modpacks and more. It means that instead of relying only on the big platforms out there, you can easily self-host and share all of your creations. It's meant to be lightweight, fast and simple.
+
+## Build
+First download all needed packages using
+```sh
+pnpm install
+```
+
+Then you can run the backend using
+```sh
+node server.js
+```
+
+## Dependencies
+WF radio is built using express.js for the backend and supports MySQL and SQLite databases. It still don't know what framework I'll be using for the frontend part. You'll only need node.js and a package manager to get started.
+
+- **Node.js**
+- **pnpm**
\ No newline at end of file