From 3f67a0a6decf64d3a1862163d0cde4d4dca2bf7e Mon Sep 17 00:00:00 2001
From: partisan <partisan@noreply@weforge.xyz>
Date: Mon, 3 Feb 2025 15:47:52 +0000
Subject: [PATCH] Added README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..47ba53b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+<p align="center">
+  <img src="https://weforge.xyz/Spitfire/Branding/raw/branch/main/active/luncher/icon.svg" alt="Logo" width="64" height="64">
+</p>
+
+<p align="center" style="font-size: 32px;">
+  <strong>Spitfire Launcher</strong>
+</p>
+
+<p align="center">
+A lightweight updater and launcher for the Spitfire browser, primarily designed for Windows systems. It checks for updates, downloads, decompresses, installs new versions, and launches the browser once updates are complete.
+</p>
+
+# How to Run
+
+This launcher is **not meant to be run manually**. It is intended to be downloaded from [spitfirerowser.xyz](https://spitfirebrowser.xyz) and used as part of the Spitfire Browser installation.
+
+However, if you want to test it locally, you can do so with the following commands:
+
+## Build Requirements
+
+- **Go 1.20+**
+- **Operating Systems:**
+  - Windows (requires `robocopy` for efficient file copying)
+  - Linux
+- **Dependencies:**  
+  The project depends on the `spitfire-luncher/spm` package which provides update installation, progress reporting, and browser launching functions (spm package is currently integrated into this repositary).
+
+## Foreground Mode
+
+To run the launcher in foreground mode (launches the browser if no update is in progress):
+
+```bash
+go run .
+```
+
+### Background Update Service
+To run the launcher as a background update service (continuously checks for and installs updates when the browser is not running):
+
+```bash
+go run . --update-service
+```
+