From bfa9530d0666a559dc02055980e8d26d0d54bb3c Mon Sep 17 00:00:00 2001
From: TerrifiedBug <dannyfeates@yahoo.co.uk>
Date: Sat, 19 Apr 2025 22:47:41 +0100
Subject: [PATCH] updated readme

---
 README.md | 42 ++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 40 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 7d023cc..4bb887a 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,41 @@
-# komodo-stacks
+# Komodo Stacks
 
-This is the komodo-stacks repository. Update this README with relevant project details.
+This repository contains a collection of Docker Compose stacks for various self-hosted applications and services. Each project is organized into its own directory with its own configuration files.
+
+## Usage
+
+Each project directory contains at least:
+- `docker-compose.yml` - The Docker Compose configuration
+- `README.md` - Project-specific documentation
+- `.env` - Environment variables for configuration (may need to be created)
+
+### General Instructions
+
+1. Navigate to the project directory of your choice:
+   ```bash
+   cd projects/project-name
+   ```
+
+2. Create or edit the `.env` file with your configuration:
+   ```bash
+   cp .env.example .env
+   nano .env
+   ```
+
+3. Start the service:
+   ```bash
+   docker-compose up -d
+   ```
+
+4. Check the logs:
+   ```bash
+   docker-compose logs -f
+   ```
+
+## Maintenance
+
+This repository is automatically synced from a set of individual Gitea repositories using a custom synchronization tool. Changes should be made to the original Gitea repositories, not directly to this GitHub repository.
+
+## License
+
+This collection is provided as-is with no warranty. Each project may have its own license - please refer to the respective project's documentation.