From a09962d73ec5400cb3d0555a563bdec38b4361a0 Mon Sep 17 00:00:00 2001
From: 1e99 <noemail@noemail>
Date: Wed, 30 Oct 2024 17:17:29 +0100
Subject: [PATCH] add instructions for building from source

---
 README.md | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1816349..9015337 100644
--- a/README.md
+++ b/README.md
@@ -21,7 +21,8 @@ When someone views the password, PassED looks at the URL. It knows the password
 This model ensures that a malicous host can not read the passwords.
 
 ## Installation
-Installation is done with docker compose.
+Installation can be done with docker compose or from source.
+### Docker Compose
 ```yaml
 services:
   "passed":
@@ -35,6 +36,21 @@ services:
       - "3000:3000"
 ```
 
+### Source
+1. Download the source code
+```sh
+git clone https://git.1e99.eu/1e99/passed.git
+```
+2. Ensure that you have go installed, if not follow this [guide](https://go.dev/doc/install).
+3. Build the project
+```sh
+go build -o passed .
+```
+4. Run the project
+```sh
+PASSED_STORE_TYPE=dir ./passed
+```
+
 ## Configuration
 Configuration is done with environment variables.
 - `PASSED_ADDRESS`: Specifies the address that PassED should listen on, defaults to `:3000`