diff --git a/README.md b/README.md index 4e2c729..b097d7e 100644 --- a/README.md +++ b/README.md @@ -9,14 +9,16 @@ A lightweight Android chat application built with React and Capacitor for connec - **Dark Theme**: Sleek black/dark UI design - **Conversation Export**: Save chats as text, log, or markdown files - **Custom System Prompts**: Inject your own system prompts for personalized interactions +- **Model Configuration**: Custom model name support for local LLMs - **Offline Ready**: Capacitor wrapper for native Android APK generation ## Tech Stack -- **Frontend**: React (Web) +- **Frontend**: React + TypeScript - **Mobile Wrapper**: Capacitor -- **Build Tool**: Vite (recommended) or Create React App -- **Testing**: Jest / React Testing Library +- **Build Tool**: Vite +- **Package Manager**: pnpm +- **Testing**: Vitest + React Testing Library - **Android Studio**: For final APK generation ## Getting Started @@ -24,25 +26,28 @@ A lightweight Android chat application built with React and Capacitor for connec ### Prerequisites - Node.js (v18+) -- npm or yarn +- pnpm - Android Studio (for APK building) - Capacitor CLI ### Installation ```bash -# Install dependencies -npm install +# Install dependencies with pnpm +pnpm install # Start development server -npm run dev +pnpm dev ``` ### Build for Android ```bash +# Type check TypeScript code +pnpm type-check + # Build the web app -npm run build +pnpm build # Sync with Capacitor npx cap sync