rework llm

1 files changed, 94 insertions, 7 deletions

diff --git a/README.md b/README.md
index 070997e62..65ad9c351 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,100 @@
 # TermAI
 
-**⚠️ WORK IN PROGRESS ⚠️**
+A powerful terminal-based AI assistant for developers, providing intelligent coding assistance directly in your terminal.
 
-This project is currently under active development.
+[![TermAI Demo](https://asciinema.org/a/dtc4nJyGSZX79HRUmFLY3gmoy.svg)](https://asciinema.org/a/dtc4nJyGSZX79HRUmFLY3gmoy)
 
-## Current Progress
+## Overview
 
-- Initial CLI setup
-- Basic functionality implementation
-- Working on core features
+TermAI is a Go-based CLI application that brings AI assistance to your terminal. It provides a TUI (Terminal User Interface) for interacting with various AI models to help with coding tasks, debugging, and more.
 
-More details coming soon.
\ No newline at end of file
+## Features
+
+- **Interactive TUI**: Built with [Bubble Tea](https://github.com/charmbracelet/bubbletea) for a smooth terminal experience
+- **Multiple AI Providers**: Support for OpenAI, Anthropic Claude, and Google Gemini models
+- **Session Management**: Save and manage multiple conversation sessions
+- **Tool Integration**: AI can execute commands, search files, and modify code
+- **Vim-like Editor**: Integrated editor with Vim keybindings for text input
+- **Persistent Storage**: SQLite database for storing conversations and sessions
+
+## Installation
+
+```bash
+# Coming soon
+go install github.com/kujtimiihoxha/termai@latest
+```
+
+## Configuration
+
+TermAI looks for configuration in the following locations:
+
+- `$HOME/.termai.json`
+- `$XDG_CONFIG_HOME/termai/.termai.json`
+- `./.termai.json` (local directory)
+
+You can also use environment variables:
+
+- `ANTHROPIC_API_KEY`: For Claude models
+- `OPENAI_API_KEY`: For OpenAI models
+- `GEMINI_API_KEY`: For Google Gemini models
+
+## Usage
+
+```bash
+# Start TermAI
+termai
+
+# Start with debug logging
+termai -d
+```
+
+### Keyboard Shortcuts
+
+- `L`: View logs
+- `N`: Create new session
+- `Esc`: Close current view
+- `Backspace`: Go back
+- `Ctrl+C` or `q`: Quit
+- `?`: Toggle help
+
+## Architecture
+
+TermAI is built with a modular architecture:
+
+- **cmd**: Command-line interface using Cobra
+- **internal/app**: Core application services
+- **internal/config**: Configuration management
+- **internal/db**: Database operations and migrations
+- **internal/llm**: LLM providers and tools integration
+- **internal/tui**: Terminal UI components and layouts
+- **internal/logging**: Logging infrastructure
+- **internal/message**: Message handling
+- **internal/session**: Session management
+
+## Development
+
+### Prerequisites
+
+- Go 1.23.5 or higher
+
+### Building from Source
+
+```bash
+# Clone the repository
+git clone https://github.com/kujtimiihoxha/termai.git
+cd termai
+
+# Build
+go build -o termai
+
+# Run
+./termai
+```
+
+## License
+
+[License information coming soon]
+
+## Contributing
+
+[Contribution guidelines coming soon]