Updated docker setup, updated README

Author: davistdaniel

README.md

@@ -102,40 +102,66 @@ In the "Saved" tab you can:
 
 This project is under active development. Please make a separate backup of your notes.
 
-### Prerequisites
 
-- Python 3.11 or higher
 
-### Using Python
+### Using Docker (Recommended)
+
+#### 1. Make a directory for kurup and the notes
 
 ```bash
-# Clone the repository
-git clone https://github.com/davistdaniel/kurup
+mkdir -p kurup/notes
 cd kurup
+```
 
-# Install dependencies
-python -m pip install "nicegui>=2.17.0"
+####  2. Make a docker-compose.yml file in the kurup folder with the following contents:
+```bash
+services:
+  kurup:
+    image: ghcr.io/davistdaniel/kurup:latest
+    container_name: kurup
+    ports:
+      - "9494:9494"
+    volumes:
+      - ./notes:/app/notes # make sure the notes folder exists before running the container‚ otherwise the folder will be owned by root.
+      # you can also use a custom path for the notes directory
+      #- /home/yourusername/Documents/notes:/app/notes                        
+    command: ["--notes_dir", "/app/notes"]
+    user: "1000:1000" # set to your own local UID:GID, run `id -u` to find UID and run `id -g` to find GID
+```
 
-# Run the application
-python main.py
+#### 3. Start the container
 
-# Open your web browser and navigate to:
-http://localhost:9494
+```bash
+sudo docker compose up -d
 ```
 
-### Using Docker (using NiceGUI's docker image)
+#### 4. Open your web browser and navigate to:
+
+http://localhost:9494
+
+### Using Python (Tested on Linux, MacOS)
+
+#### Prerequisites
+
+- Python 3.11 or higher
+
 ```bash
 # Clone the repository
 git clone https://github.com/davistdaniel/kurup
 cd kurup
 
-# start the container, you can edit docker-compose.yml to configure
-sudo docker compose up -d
+# Install dependencies
+python -m pip install "nicegui>=2.17.0"
+
+# Run the application
+python main.py
 
 # Open your web browser and navigate to:
 http://localhost:9494
 ```
 
+
+
 ## 🔄 Updating
 
 > [!NOTE]  
@@ -158,11 +184,11 @@ http://localhost:9494
 
 ### Docker
 ```bash
-# Pull the latest changes from the repository
-git pull origin main
-
 # restart the container
 sudo docker compose down
+# pull the latest image
+sudo docker compose pull
+# start the container
 sudo docker compose up -d
 
 # Open your web browser and navigate to:

docker-compose.yml

@@ -5,8 +5,8 @@ services:
     ports:
       - "9494:9494"
     volumes:
-      - notes:/app/notes # make sure the notes folder exists before running the container‚ otherwise the folder will be owned by root.
+      - ./notes:/app/notes # make sure the notes folder exists before running the container‚ otherwise the folder will be owned by root.
       # you can also use a custom path for the notes directory
       #- /home/yourusername/Documents/notes:/app/notes                        
     command: ["--notes_dir", "/app/notes"]
-    user: "1000:1000" # set to your own local UID:GID, run `id -u` to find UID and run `id -g` to find GID
+    user: "1000:1000" # set to your own local UID:GID, run `id -u` to find UID and run `id -g` to find GID