@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2026 anomalyco
+Copyright (c) 2026 Blankeos
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 
@@ -1,28 +1,35 @@
-# crabcode
+# 🦀 crabcode
 
 > [!WARNING]  
-> This project is very very early (like experiment-early) don't expect it to get to OpenCode level anytime soon.
+> This ambitious project is very very early (like experiment-early) don't expect it to get to OpenCode level anytime soon.
+> Like it literally doesn't even work yet.
 
-A purely Rust-based AI CLI coding agent with a beautiful terminal UI for interactive AI-assisted development.
+A purely Rust-based AI CLI coding agent with a beautiful terminal UI for interactive "agentic engineering".
+
+> In the words of the buildwithpi.ai creator, 'There are many coding agents, this one is mine'.
+>
+> It's OpenCode but in pure Rust 🦀 w/ my personal flavors.
+>
+> ~ Carlo (Author)
 
 ![screenshot](_docs/screenshot.png)
 
 ## Features
 
 - **Made with Rust** - Uses ratatui, crossterm and nucleo (fuzzy search), all fast tech.
-- **Built for the OpenCode user** - works out of the box w/ opencode themes, every UX and more from opencode carefully ported into rust.
-- **Opens literally instantly** - one of my main motivations why I made this, rust! :D Very lightweight after build.
+- **Sounds** - I wanted this in opencode, I just made it built in instead of a plugin.
+- **TPS, TTFT, Latency metrics** - Also wanted this in opencode, just made it built-in.
+- **Opens instantly** - one of my main motivations why I made this! :D Very lightweight after build.
 - **Terminal UI (TUI)** - Beautiful, responsive interface built with [ratatui](https://github.com/ratatui-org/ratatui)
-- **Agent System** - Switch between PLAN (read-only analysis) and BUILD (implementation) agents with TAB
-- **Multiple Model Support** - Works with nano-gpt, z.ai, and other AI models via HTTP APIs
-- **Command System** - Intuitive commands: `/sessions`, `/new`, `/connect`, `/models`, `/exit`
-- **Auto-suggestions** - Get suggestions for commands when typing `/`
-- **Status Bar** - Shows version, current directory, git branch, active agent, and model
-- **Session Management** - Create and manage multiple chat sessions
-- **Streaming Responses** - Real-time streaming of AI responses
-- **Git Integration** - Detects and displays current git branch
+- **Built for the OpenCode user** - works out of the box w/ opencode themes, every UX, and some existing configs so you don't need to force your team to use crabcode.
+  - **Same UX** - carefully ported most of the good UX from OpenCode i.e. shortcuts, etc.
+  - **Agent System** - Switch between PLAN (read-only analysis) and BUILD (implementation) agents with TAB, and custom agents.
+  - **Multiple Model Support** - Works w/ the same models.dev support.
+  - **Command System** - Intuitive commands: `/sessions`, `/new`, `/connect`, `/models`, `/exit` + custom commands.
+  - **Session Management** - Create and manage multiple chat sessions
+  - **Streaming Responses** - Real-time streaming of AI responses (w/ [aisdk.rs](https://aisdk.rs))
 
-## Installation
+## Quick Start
 
 Install via cargo:
 
@@ -50,18 +57,19 @@ cargo install crabcode
 
 ### Commands
 
-| Command               | Description                                     |
-| --------------------- | ----------------------------------------------- |
-| `/sessions`           | List all sessions                               |
-| `/new [name]`         | Create a new session                            |
-| `/connect <provider>` | Configure model provider (e.g., nano-gpt, z.ai) |
-| `/models`             | List available models                           |
-| `/exit`               | Quit crabcode                                   |
+| Command     | Description                      |
+| ----------- | -------------------------------- |
+| `/sessions` | List all sessions                |
+| `/new`      | Create a new session             |
+| `/connect`  | Open the provider connect dialog |
+| `/models`   | List available models            |
+| `/exit`     | Quit crabcode                    |
 
 ### Key Bindings
 
 | Key              | Action                                 |
 | ---------------- | -------------------------------------- |
+| `Ctrl+X`         | Open the shortcuts dialog              |
 | `TAB`            | Switch between PLAN and BUILD agents   |
 | `Enter`          | Submit message or execute command      |
 | `Ctrl+C` (once)  | Clear input                            |
@@ -76,15 +84,38 @@ cargo install crabcode
 
 ## Configuration
 
-API keys are stored securely in `~/.config/crabcode`.
+Your credentials are stored in an OS-specific data directory:
+
+- macOS: `~/Library/Application Support/crabcode/auth.json`
+- Linux: `~/.local/share/crabcode/auth.json`
+
+Read the [extensive list of configs here](/_docs/config.mdx).
 
 ### Supported Providers
 
-These are my priority. Will be powered by mostly [aisdk](https://github.com/lazy-hq/aisdk) + [models.dev](https://models.dev)
+> Will be powered by mostly [aisdk](https://github.com/lazy-hq/aisdk) + [models.dev](https://models.dev)
+> So **most of them** will work out of the box.
+
+I tried crabcode specifically for these providers:
+
+- [x] **opencode-zen**
+- [x] **nano-gpt**
+- [x] **zai**
+- [x] **minimax**
+- [x] **fireworks**
+- [x] **baseten**
+- [x] **ollama**
 
-- [ ] **nano-gpt** - NanoGPT API
-- [ ] **z.ai** - z.ai coding plan
-- [ ] **minimax.io**
+> Feel free to create an issue / add to this list if you tried
+
+### Known unsupported providers
+
+> I might work harder to support these in the future.
+
+- ChatGPT/Codex Subscription (Though they have good-will to support OpenCode, so maybe CrabCode can as well). **might support later**.
+- Kimi For Coding Subscription - I keep getting 401 but it works in OpenCode, I may have to contact them first. **might support later**
+- Gemini - It's OAuth + also very unsure. So currently no.
+- Claude Code Subscription - Known to explicitly not like harnesses. So never will, sorry.
 
 ## Development
 
@@ -112,25 +143,21 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 
 ## Inspiration
 
-This project was inspired by [anomalyco/opencode](https://github.com/anomalyco/opencode).
+This project was inspired by [anomalyco/opencode](https://github.com/anomalyco/opencode). Also made this project w/ OpenCode btw, so thank you OpenCode! 🙏
 
 ## Scope
 
-- Chat, switch models, agents
-- Minimal configurations (I want it to just feel at least like vanilla opencode)
-- The cheapest model providers (GLM, etc.)
-- A ding sound, my only opencode plugin at the moment.
-- No reverse-engineering oauth from big AI (Codex, Claude Code, Gemini), at least for now (Don't wanna get in trouble).
-- Possibly ralphy? (very far, idk how to do that)
-- ACP? (very far, idk how to do that)
-- No plugin ecosystem
-- No desktop app
-- No web sharing thing
+- [x] Chat, switch models, agents
+- [x] Minimal configurations (I want it to just feel at least like vanilla opencode)
+- [x] The cheapest model providers (GLM, etc.)
+- [ ] A ding sound, my only opencode plugin at the moment.
+- [x] No reverse-engineering oauth from big AI (Codex, Claude Code, Gemini), at least for now (Don't wanna get in trouble).
+- [ ] Possibly ralphy? (very far, idk how to do that)
+- [ ] ACP w/ Zed? (very far, idk how to do that)
+- [x] No plugin ecosystem
+- [x] No desktop app
+- [x] No web sharing thing
 
 ## Why?
 
 I'm learning rust :D. Built a few TUIs as practice. Also been making AI chat apps on web, so I wanna work on this.
-
-## Repository
-
-[https://github.com/blankeos/crabcode](https://github.com/blankeos/crabcode)