updated the README.md

Author: DSoftwareArtist

README.md

@@ -24,122 +24,43 @@
 
 ---
 
-## 3. UI/UX Specification
-
-### Layout Structure
-
-**Header**
-
-- Application title: "LLM SQL Analytics"
-- Navigation: Dashboard, Query Interface, Schema Docs, Settings
-
-**Main Content Area**
-
-- Dashboard: Overview of connected databases and recent queries
-- Query Interface: Natural language input + SQL preview + results table
-- Schema Docs: List of uploaded documents with semantic search
-- Settings: Database connection configuration
-
-**Footer**
-
-- Version info and copyright
-
-### Visual Design
-
-**Color Palette**
-
-- Primary: `#1E3A5F` (Deep Navy)
-- Secondary: `#3D5A80` (Slate Blue)
-- Accent: `#48CAE4` (Cyan)
-- Background: `#F8F9FA` (Light Gray)
-- Surface: `#FFFFFF` (White)
-- Text Primary: `#212529` (Dark Gray)
-- Text Secondary: `#6C757D` (Medium Gray)
-- Success: `#28A745` (Green)
-- Error: `#DC3545` (Red)
-- Warning: `#FFC107` (Yellow)
-
-**Typography**
-
-- Headings: "Inter", sans-serif, 600 weight
-- Body: "Inter", sans-serif, 400 weight
-- Monospace (SQL): "JetBrains Mono", monospace
-
-**Spacing**
-
-- Base unit: 8px
-- Container max-width: 1200px
-- Card padding: 24px
-- Section margin: 32px
-
-### Components
-
-**Query Input Card**
-
-- Textarea for natural language input
-- "Generate SQL" button (primary style)
-- "Execute" button (accent style)
-- SQL preview panel with syntax highlighting
-
-**Results Table**
-
-- Sortable columns
-- Pagination for large results
-- Export to CSV option
-
-**Schema Doc Card**
-
-- Document name
-- Upload date
-- Preview snippet
-- Semantic search input
-
-**Database Connection Card**
-
-- Connection name
-- Database type indicator
-- Status indicator (connected/disconnected)
-- Edit/Delete actions
-
----
-
-## 4. Functionality Specification
+## 3. Functionality Specification
 
 ### Core Features
 
-#### 4.1 Database Connection Management
+#### 3.1 Database Connection Management
 
 - Add PostgreSQL database connections with connection details
 - Test database connectivity
 - Store connection configurations securely
 - Support multiple database connections
 
-#### 4.2 Schema Introspection
+#### 3.2 Schema Introspection
 
 - Automatically fetch table names and column information
 - Store schema in PostgreSQL with pgvector for semantic search
 - Support uploading schema documentation (PDF)
 
-#### 4.3 Natural Language to SQL
+#### 3.3 Natural Language to SQL
 
 - Accept natural language queries
 - Use LLM to convert natural language to SQL
 - Support SELECT, INSERT, UPDATE, DELETE operations
 - Include validation and error handling
 
-#### 4.4 Semantic Schema Search
+#### 3.4 Semantic Schema Search
 
 - Embed schema documentation using sentence-transformers
 - Store embeddings in pgvector
 - Search schema semantically to find relevant tables/columns
 
-#### 4.5 Query Execution
+#### 3.5 Query Execution
 
 - Execute generated SQL against target database
 - Return formatted results
 - Handle errors gracefully with user-friendly messages
 
-#### 4.6 Query History
+#### 3.6 Query History
 
 - Store all queries with timestamps
 - View past queries and their results
@@ -168,45 +89,7 @@
 
 ---
 
-## 5. Database Schema
-
-### Django Models
-
-```
-DatabaseConnection
-- id: UUID (primary key)
-- name: CharField (unique)
-- host: CharField
-- port: IntegerField
-- database: CharField
-- username: CharField
-- password: CharField (encrypted)
-- created_at: DateTimeField
-- updated_at: DateTimeField
-- is_active: BooleanField
-
-SchemaDocument
-- id: UUID (primary key)
-- connection: ForeignKey(DatabaseConnection)
-- name: CharField
-- content: TextField
-- embedding: VectorField (pgvector)
-- uploaded_at: DateTimeField
-
-QueryHistory
-- id: UUID (primary key)
-- connection: ForeignKey(DatabaseConnection)
-- natural_language: TextField
-- generated_sql: TextField
-- executed_sql: TextField (nullable)
-- result: JSONField (nullable)
-- error: TextField (nullable)
-- created_at: DateTimeField
-```
-
----
-
-## 6. API Endpoints
+## 4. API Endpoints
 
 | Method | Endpoint                      | Description                    |
 | ------ | ----------------------------- | ------------------------------ |
@@ -225,7 +108,7 @@ QueryHistory
 
 ---
 
-## 7. Acceptance Criteria
+## 5. Acceptance Criteria
 
 1. ✓ User can add PostgreSQL database connections
 2. ✓ User can test database connectivity