From 812cec0d87fb344ec18e53605109fbfc458328c8 Mon Sep 17 00:00:00 2001
From: Harm Manders <harmmanders@gmail.com>
Date: Fri, 23 Aug 2024 15:36:06 +0200
Subject: [PATCH] Updated Readme

---
 README.md | 55 +++++++++++++++++++++++++++++++++++++------------------
 1 file changed, 37 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index 8c387bd70..dd7696e4f 100644
--- a/README.md
+++ b/README.md
@@ -1,26 +1,45 @@
-# Quasar App (hkq)
 
-A Quasar Framework app
+# Shieldmaiden.app
 
-## Install the dependencies
-```bash
-npm install
-```
+## Introduction
 
-### Start the app in development mode (hot-code reloading, error reporting, etc.)
-```bash
-quasar dev
-```
 
-### Lint the files
-```bash
-npm run lint
+## How to contribute
+
+Thanks for showing interest in contributing to our project.
+This project started out as a hobby project but over the years it has grown to a more serious application.
+If you would wish to contribute to this project feel free to contact us via [Discord](https://discord.gg/fhmKBM7) or via an [Discussion](https://github.com/HarmlessKey/Shieldmaiden/discussions) on GitHub.
+We will give you access to our contributors guide.
+
+### Requirements
+To get started with development you will need:
+- Node 16. We recommend using `nvm` or something similar to manage your node versions.
+- A personal firebase project
+- DB init JSON found in our contributors guide.
+
+### Installation
+If you've followed our contributors guide, you can simply run:
+
+```
+npm i
 ```
 
-### Build the app for production
-```bash
-quasar build
+followed by 
+
+```
+npm run ssr
 ```
 
-### Customize the configuration
-See [Configuring quasar.conf.js](https://v1.quasar.dev/quasar-cli/quasar-conf-js).
+To start the dev env.
+
+**IT'S EASY!! :rocket:**
+
+## Bug reports / Feature requests
+There are two main ways to submit bug reports or request new features: **[Discord](https://discord.gg/fhmKBM7)** or **[Github](https://github.com/HarmlessKey/Shieldmaiden/issues)**.
+
+Discord is our main communication channel with our community.
+
+We're in the process of moving our Azure DevOps board over to Github, but we want to use Github to keep track of upcoming features.
+
+## Pull Requests
+This is something we will have to figure out in collaboration with you, as there haven't been any external collaborators thus far!