From 972519709c93d59bc4ca9f54923c45018ba8aa96 Mon Sep 17 00:00:00 2001
From: Ano-sys <timo.niemann02@gmail.com>
Date: Sun, 22 Feb 2026 22:34:01 +0100
Subject: [PATCH] Add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cdbe4f0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# DirectoryScanService
+
+This repository contains two submodule projects that work together to transfer files over a simple TCP-based protocol.
+
+## Clone With Submodules
+
+Use `--recurse-submodules` when cloning so both projects are checked out automatically:
+
+```bash
+git clone --recurse-submodules https://git.timoniemann.de/t/DirectoryScanService.git
+```
+
+If you already cloned the repository without submodules:
+
+```bash
+git submodule update --init --recursive
+```
+
+## Projects
+
+- [`DirectoryScanSender`](./DirectoryScanSender)  
+  Scans a directory recursively and sends eligible files to a TCP server.  
+  README: [`DirectoryScanSender/README.md`](./DirectoryScanSender/README.md)
+
+- [`DirectoryScanReceiver`](./DirectoryScanReceiver)  
+  Runs a TCP server that receives file data and writes it into an output directory.  
+  README: [`DirectoryScanReceiver/README.md`](./DirectoryScanReceiver/README.md)
+
+## How They Fit Together
+
+- `DirectoryScanSender` is the client that sends files.
+- `DirectoryScanReceiver` is the server that accepts and stores them.
+- Both use the same simple delimiter-based message format and default TCP port (`7156`).