docs: added README

Author: ErikBjare

README.md

@@ -1,7 +1,45 @@
-# Tauri + React + Typescript
+# gptme-tauri
 
-This template should help get you started developing with Tauri, React and Typescript in Vite.
+A desktop application for [gptme](https://github.com/gptme/gptme) built with [Tauri](https://tauri.app/).
 
-## Recommended IDE Setup
+This app packages the [gptme-webui](https://github.com/gptme/gptme-webui) frontend with a bundled `gptme-server` binary, providing a standalone desktop experience for gptme.
 
-- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
+## Features
+
+- 🖥️ Native desktop app with web UI
+- 📦 Self-contained with bundled gptme-server
+- 🚀 No need to install Python or manage dependencies
+- 🔧 All gptme tools and capabilities available
+
+## Prerequisites
+
+- [Node.js](https://nodejs.org/) (for building)
+- [Rust](https://rustup.rs/) (for Tauri)
+- Git submodules initialized
+
+## Development
+
+```bash
+# Install dependencies and initialize submodules
+git submodule update --init --recursive
+npm install
+
+# Run in development mode
+make dev
+```
+
+## Building
+
+```bash
+# Build the application
+make build
+```
+
+The built application will be in `src-tauri/target/release/bundle/`.
+
+## Project Structure
+
+- `gptme/` - gptme source code (submodule)
+- `gptme-webui/` - Web UI frontend (submodule)
+- `src-tauri/` - Tauri backend configuration
+- `bins/` - Contains the bundled gptme-server binary