From 7fff8ffe72111cff5a17638501393aaa338959a9 Mon Sep 17 00:00:00 2001
From: balabanovan530 <175+balabanovan530@noreply.localhost>
Date: Thu, 28 May 2026 13:59:27 +0000
Subject: [PATCH] Add README.md

---
 README.md | 34 +++++++++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d00952d..108b120 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,33 @@
-<LOCAL_CONTENT>
\ No newline at end of file
+# RAG Agent Project
+
+## Installation
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -r requirements.txt
+```
+
+## Environment Variables
+- `OPENAI_API_KEY` – API key for OpenAI or Ollama. If using local Ollama set `OPENAI_API_BASE_URL=http://localhost:11434/v1`.
+
+## Usage
+### Load documents into vector store
+```bash
+python init_loader.py /path/to/text/files
+```
+
+### Start interactive CLI
+```bash
+python cli_client.py /add --text "Your document content"
+python cli_client.py /search --text "What is LangChain?"
+python cli_client.py /quit
+```
+
+### Run agent directly
+```bash
+python agent.py
+```
+
+## Development
+- Tests are not included but can be added in `tests/`.
+- Lint with `ruff .` and format with `black .`.
\ No newline at end of file