From 66e16c23c6037dc990eca8687e40e9652663944c Mon Sep 17 00:00:00 2001
From: hhofmann <h.hofmann@pyrexx.com>
Date: Mon, 13 Apr 2026 16:39:53 +0200
Subject: [PATCH] Add README.md with documentation

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d52e556
--- /dev/null
+++ b/README.md
@@ -0,0 +1,76 @@
+# Mem0 Docker with Qdrant
+
+Dockerized memory service using mem0 with Qdrant vector database for semantic memory storage.
+
+## Quick Start
+
+1. Copy the example environment file:
+```bash
+cp example.env .env
+```
+
+2. Edit `.env` with your configuration:
+   - `MEM0_PORT`: Port for the mem0 API
+   - `QDRANT_HOST`: Qdrant host (default: qdrant)
+   - `QDRANT_PORT`: Qdrant port (default: 6333)
+   - `EMBEDDING_URL`: llama.cpp embedding endpoint URL
+   - `EMBEDDING_DIMS`: Embedding dimension size
+
+3. Start the services:
+```bash
+docker-compose up -d
+```
+
+## API Endpoints
+
+### Health Check
+```
+GET /health
+```
+
+### Add Memory
+```
+POST /add
+Content-Type: application/json
+
+{
+  "message": "Memory text to store",
+  "user_id": "default",
+  "metadata": {}
+}
+```
+
+### Search Memories
+```
+POST /search
+Content-Type: application/json
+
+{
+  "query": "Search query",
+  "user_id": "default",
+  "limit": 5
+}
+```
+
+### Get All Memories
+```
+GET /memories?user_id=default
+```
+
+### Delete Memory
+```
+DELETE /delete/{memory_id}
+```
+
+## Files
+
+- `docker-compose.yml`: Docker Compose configuration
+- `Dockerfile`: Container build instructions
+- `main.py`: FastAPI memory API server
+- `mem0_server.py`: Alternative HTTP server implementation
+- `requirements.txt`: Python dependencies
+- `example.env`: Environment variable template
+
+## Configuration
+
+The service requires an external llama.cpp embedding endpoint. Configure the `EMBEDDING_URL` to point to your embedding service.