From d0dc84da81206c0cbb479ad4a908121fc9b68285 Mon Sep 17 00:00:00 2001
From: repi <repi@repi.fun>
Date: Mon, 1 Jan 2001 00:00:00 +0000
Subject: [PATCH] docs: update README with full project documentation

---
 README.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 59 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index c98e2c0..a931c50 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,60 @@
-# codeboard
+# CodeBoard
 
-Codebase → Onboarding Docs Generator. Paste a GitHub repo URL, get interactive developer onboarding documentation in minutes.
\ No newline at end of file
+Codebase → Onboarding Docs Generator. Paste a GitHub repo URL, get interactive developer onboarding documentation in minutes.
+
+## Architecture
+
+```
+codeboard/
+├── apps/
+│   ├── web/         # Next.js 14 frontend + API routes
+│   └── worker/      # BullMQ job processor
+├── packages/
+│   ├── shared/      # TypeScript types
+│   ├── parser/      # Babel-based AST parser (JS/TS) + regex (Python)
+│   ├── llm/         # OpenAI/Anthropic abstraction + prompt pipeline
+│   ├── diagrams/    # Mermaid diagram generators
+│   └── database/    # Prisma schema + client
+```
+
+## Quick Start
+
+```bash
+# Install dependencies
+npm install
+
+# Build all packages
+npm run build
+
+# Start with Docker
+docker compose up
+```
+
+## Development
+
+```bash
+# Run dev server (all workspaces)
+npm run dev
+
+# Build
+npm run build
+```
+
+## Tech Stack
+
+- **Frontend**: Next.js 14, React 18, Tailwind CSS 4
+- **Backend**: BullMQ workers, Redis pub/sub for real-time progress
+- **Parser**: @babel/parser for JS/TS, regex-based for Python
+- **LLM**: Provider abstraction (OpenAI GPT-4o / Anthropic Claude)
+- **Diagrams**: Mermaid.js auto-generated architecture & dependency graphs
+- **Database**: PostgreSQL + Prisma
+- **Queue**: Redis + BullMQ
+- **Deployment**: Docker multi-stage builds
+
+## License
+
+MIT
+
+---
+
+Built by [Vectry](https://company.repi.fun) — Engineering AI into your workflow.