From feceab03b11ed88f48c0d6d44c9221b803ee77f9 Mon Sep 17 00:00:00 2001 From: "Gu://em_" Date: Sat, 10 May 2025 20:00:17 +0200 Subject: [PATCH] Small upates to the README --- README.md | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d807e85..39629d9 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,23 @@ # WF radio -## ⚠ Warning: this project isn't even in alpha yet +## 🚧 Warning: this project isn't even in alpha yet Everything is still in WIP so don't expect it to work yet. -## About +## â„šī¸ 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 +## 🔨 Build + +First make sure you have the following dependencies installed: +- **Node.js** +- **pnpm** + +Then download all needed packages using ```sh pnpm install ``` -Then you can run the backend using +Finally you can run the backend using ```sh pnpm start ``` @@ -21,8 +26,10 @@ Or alternatively 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. +## 🔧 Configuration -- **Node.js** -- **pnpm** \ No newline at end of file +All settings are located in [config/config.json](config/config.json). For more explainations and possible values, give a look to the documentation (incomming). + +## 🔗 Documentation + +WIP \ No newline at end of file