From 5c3d6f913e39e1d201d27103c26befac4b93d8e9 Mon Sep 17 00:00:00 2001
From: Ben Phelps <ben@phelps.io>
Date: Wed, 24 Aug 2022 11:02:51 +0300
Subject: [PATCH] update readme

---
 README.md | 35 +++++++++++++++++++++++++++++------
 1 file changed, 29 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index f5ffe7347..6ea9592fe 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,34 @@
 ## Getting Started
 
+Using docker compose:
+
+```yaml
+version: '3.3'
+services:
+    homepage:
+        image: ghcr.io/benphelps/homepage:main
+        container_name: homepage
+        ports:
+            - 3000:3000
+        volumes:
+            - /path/to/config:/app/config
+```
+
+or docker run:
+
+```bash
+docker run -p 3000:3000 -v /path/to/config:/app/config ghcr.io/benphelps/homepage:main
+```
+
+## Configuration
+
+Configuration files will be genereted and placed on the first request.
+
+Configuration is done in the /config directory using .yaml files.  Refer to each config for
+the specific configuration options.
+
+## Development
+
 Install NPM packages, this project uses [pnpm](https://pnpm.io/) (and so should you!):
 
 ```bash
@@ -13,9 +42,3 @@ pnpm dev
 ```
 
 Open [http://localhost:3000](http://localhost:3000) to start.
-
-
-## Configuration
-
-Configuration is done in the /config directory using .yaml files.  Refer to each config for
-the specific configuration options.