docs: update README.md with comprehensive documentation index

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Author: Copilot

README.md

@@ -2,49 +2,86 @@
 
 Enterprise low-code platform mobile runtime built with Expo, React Native, and TypeScript.
 
+> **Metadata-driven runtime** — interprets ObjectUI metadata (Views, Forms, Dashboards, Actions) from an ObjectStack server and renders them as native mobile components. No hardcoded business logic.
+
 ## Tech Stack
 
-- **Framework:** Expo SDK 54 (Managed Workflow)
-- **Navigation:** Expo Router (file-based routing)
-- **Language:** TypeScript (strict mode)
-- **Styling:** NativeWind v4 (Tailwind CSS for React Native)
-- **UI Components:** shadcn/ui pattern (`components/ui/`)
-- **Icons:** lucide-react-native
-- **State Management:** Zustand
-- **Data Fetching:** TanStack Query (React Query)
+| Category | Technology |
+|----------|-----------|
+| **Framework** | Expo SDK 54 (Managed Workflow) |
+| **Navigation** | Expo Router v6 (file-based routing) |
+| **Language** | TypeScript (strict mode) |
+| **Styling** | NativeWind v4 (Tailwind CSS for React Native) |
+| **UI Components** | shadcn/ui pattern (`components/ui/`) |
+| **Icons** | lucide-react-native |
+| **Client State** | Zustand |
+| **Server State** | @objectstack/client-react (TanStack Query) |
+| **Auth** | better-auth + @better-auth/expo |
+| **Offline Storage** | expo-sqlite |
+| **Metadata Cache** | react-native-mmkv |
+
+## Getting Started
+
+```bash
+# Install dependencies
+npm install --legacy-peer-deps
+
+# Copy environment variables
+cp .env.example .env.local
+
+# Start development server
+npx expo start
+```
 
 ## Project Structure
 
 ```
-├── app/                    # Expo Router pages
-│   ├── _layout.tsx         # Root layout (providers)
-│   └── (tabs)/             # Bottom tab navigation
-│       ├── _layout.tsx     # Tab bar configuration
-│       ├── index.tsx       # Home / Dashboard
-│       ├── apps.tsx        # Apps listing
-│       ├── notifications.tsx
-│       └── profile.tsx
+├── app/                            # Expo Router pages
+│   ├── _layout.tsx                 # Root layout (providers, auth guard)
+│   ├── (auth)/                     # Authentication screens
+│   ├── (tabs)/                     # Main tab navigation
+│   └── (app)/                      # Dynamic app CRUD screens
 ├── components/
-│   └── ui/                 # Reusable UI components (shadcn pattern)
-│       ├── Button.tsx
-│       ├── Card.tsx
-│       └── Input.tsx
-├── lib/
-│   └── utils.ts            # cn() utility (clsx + tailwind-merge)
-├── global.css              # Tailwind base + CSS variables (light/dark)
-├── tailwind.config.js      # Tailwind configuration
-├── babel.config.js         # Babel + NativeWind preset
-├── metro.config.js         # Metro + NativeWind integration
-└── nativewind-env.d.ts     # NativeWind TypeScript types
+│   ├── ui/                         # Design system primitives
+│   ├── renderers/                  # ObjectUI rendering engine
+│   ├── actions/                    # Action system
+│   ├── common/                     # Shared components
+│   ├── query/                      # Query builder UI
+│   ├── batch/                      # Batch operation UI
+│   ├── views/                      # Saved views UI
+│   └── sync/                       # Offline sync UI
+├── hooks/                          # Custom React hooks
+├── lib/                            # Core libraries
+├── stores/                         # Zustand state stores
+└── docs/                           # Documentation
 ```
 
-## Getting Started
+## Scripts
 
-```bash
-npm install
-npx expo start
-```
+| Command | Description |
+|---------|-------------|
+| `npm start` | Start Expo development server |
+| `npm run lint` | TypeScript check + ESLint |
+| `npm test` | Run Jest tests |
+| `npm run format` | Format with Prettier |
+
+## Documentation
+
+Comprehensive project documentation is available in the [`docs/`](./docs/) directory:
+
+| Document | Description |
+|----------|-------------|
+| **[Architecture](./docs/ARCHITECTURE.md)** | System architecture, layer design, provider hierarchy, module dependencies |
+| **[UI/UX Design](./docs/UI-DESIGN.md)** | Design system, view renderers, field types, interaction patterns |
+| **[Data Layer](./docs/DATA-LAYER.md)** | Offline-first architecture, sync queue, conflict resolution, caching |
+| **[API Integration](./docs/API-INTEGRATION.md)** | SDK usage, authentication, hook reference, error handling |
+| **[Security](./docs/SECURITY.md)** | Auth security, data protection, network security, threat model |
+| **[Testing](./docs/TESTING.md)** | Testing strategy, tooling, unit/integration/E2E guidelines |
+| **[Deployment](./docs/DEPLOYMENT.md)** | Build system, EAS Build, OTA updates, CI/CD pipeline |
+| **[Contributing](./docs/CONTRIBUTING.md)** | Development workflow, coding standards, PR process |
+| **[Roadmap](./docs/ROADMAP.md)** | Development phases, SDK dependency matrix, release plan |
+| **[SDK Gap Analysis](./docs/SDK-GAP-ANALYSIS.md)** | Missing SDK APIs, impact analysis, workarounds |
 
 ## Design System
 
-The app uses a CSS-variable-based design token system with light and dark mode support. Color tokens are defined in `global.css` and consumed via Tailwind classes.
+The app uses a CSS-variable-based design token system with light and dark mode support. Color tokens are defined in `global.css` and consumed via Tailwind classes. See [UI/UX Design](./docs/UI-DESIGN.md) for the full specification.