Skip to content

Commit e666627

Browse files
docs: update README content and add project logo
Refactor README layout to include a new logo, update the project description, and improve the presentation of badges and the "Why Kairo?" section.
1 parent f021500 commit e666627

2 files changed

Lines changed: 102 additions & 130 deletions

File tree

README.md

Lines changed: 102 additions & 130 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,43 @@
11
<div align="center">
22

3-
# 📚 Kairo
3+
<img src="screenshots/logo.png" alt="Kairo" width="80" />
44

5-
**A terminal task manager built for developers who are tired of fighting their tools.**
5+
# Kairo
66

7-
Fast. Local. Yours.
7+
**The terminal task manager for developers who live in their editor.**
88

9-
![Demo](screenshots/demo.gif)
9+
No browser tabs. No subscriptions. No mouse. Just your tasks — exactly where your brain already is.
1010

1111
<br/>
1212

13-
<p align="center">
14-
<a href="https://github.com/programmersd21/kairo/releases">
15-
<img src="https://img.shields.io/github/v/release/programmersd21/kairo?style=for-the-badge&logo=github&color=7c3aed" />
16-
</a>
17-
<a href="https://github.com/programmersd21/kairo/actions">
18-
<img src="https://img.shields.io/github/actions/workflow/status/programmersd21/kairo/ci.yml?branch=main&style=for-the-badge&logo=github&color=2563eb" />
19-
</a>
20-
<a href="https://goreportcard.com/report/github.com/programmersd21/kairo">
21-
<img src="https://img.shields.io/badge/go%20report-A%2B-brightgreen?style=for-the-badge&logo=go&logoColor=white" />
22-
</a>
23-
<img src="https://img.shields.io/github/downloads/programmersd21/kairo/total?style=for-the-badge&logo=github" />
24-
<a href="https://opensource.org/licenses/MIT">
25-
<img src="https://img.shields.io/badge/License-MIT-f59e0b?style=for-the-badge" />
26-
</a>
27-
</p>
13+
[![Release](https://img.shields.io/github/v/release/programmersd21/kairo?style=for-the-badge&logo=github&color=7c3aed)](https://github.com/programmersd21/kairo/releases)
14+
[![CI](https://img.shields.io/github/actions/workflow/status/programmersd21/kairo/ci.yml?branch=main&style=for-the-badge&logo=github&color=2563eb)](https://github.com/programmersd21/kairo/actions)
15+
[![Go Report](https://img.shields.io/badge/go%20report-A%2B-brightgreen?style=for-the-badge&logo=go&logoColor=white)](https://goreportcard.com/report/github.com/programmersd21/kairo)
16+
[![Downloads](https://img.shields.io/github/downloads/programmersd21/kairo/total?style=for-the-badge&logo=github)](https://github.com/programmersd21/kairo/releases)
17+
[![License: MIT](https://img.shields.io/badge/License-MIT-f59e0b?style=for-the-badge)](https://opensource.org/licenses/MIT)
2818

29-
</div>
19+
<br/>
3020

31-
![Home Screen](screenshots/home_screen.png)
21+
![Kairo Demo](screenshots/demo.gif)
3222

33-
---
23+
</div>
3424

35-
You know that feeling when your task manager gets in the way of your actual work?
25+
---
3626

27+
## Why Kairo?
3728

38-
Kairo was built because of that feeling.
29+
Most task managers make you context-switch out of your flow. Kairo doesn't.
3930

40-
No browser tabs. No subscriptions. No mouse. Just you, your terminal, and your tasks — right where your brain already lives.
31+
| Pain point | What Kairo does |
32+
|---|---|
33+
| GUI apps break your focus | Lives entirely in your terminal |
34+
| Cloud tools own your data | Everything local, stored in SQLite |
35+
| Plain-text tools lack structure | Full tagging, filtering, and fuzzy search |
36+
| Legacy TUIs feel dated | Modern, animated, keyboard-first UX |
4137

4238
---
4339

44-
## ⚡ Get started in seconds
40+
## Quick Start
4541

4642
**macOS (Homebrew)**
4743
```bash
@@ -68,125 +64,90 @@ Then just run:
6864
kairo
6965
```
7066

71-
Press `n` to create your first task. `ctrl+s` to save it. That's it.
67+
Press `n` to create your first task. `ctrl+s` to save. That's it.
7268

7369
> Works best on Alacritty. Some terminals may have rendering quirks — see [#16](https://github.com/programmersd21/kairo/issues/16).
7470
7571
---
7672

77-
## 💫 Star History
78-
79-
<a href="https://www.star-history.com/?repos=programmersd21%2Fkairo&type=date&legend=top-left">
80-
<picture>
81-
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/chart?repos=programmersd21/kairo&type=date&theme=dark&legend=top-left" />
82-
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/chart?repos=programmersd21/kairo&type=date&legend=top-left" />
83-
<img alt="Star History Chart" src="https://api.star-history.com/chart?repos=programmersd21/kairo&type=date&legend=top-left" />
84-
</picture>
85-
</a>
86-
87-
---
88-
89-
## 🧠 Why Kairo?
90-
91-
Most tools ask you to adapt to them. Kairo adapts to you.
92-
93-
| The problem | What Kairo does instead |
94-
|---|---|
95-
| GUI apps pull you away from your flow | Lives entirely in your terminal |
96-
| Cloud tools own your data | Everything stays local, in SQLite |
97-
| Plain-text tools lack structure | Full tagging, filtering, and fuzzy search |
98-
| Legacy TUIs feel clunky | Modern, animated, keyboard-first UX |
99-
100-
![Filter Tags](screenshots/filter_tags.png)
101-
102-
Your tasks are yours. They don't belong in someone else's cloud.
103-
104-
---
105-
106-
## ✨ What it can do
107-
108-
### Nested Tasks & Hierarchy
109-
Organize your workspace into hierarchies.
110-
111-
- **Creating Nested Tasks**: When creating or editing a task, use the **Parent** field to specify the ID of the parent task. This instantly nests the task under the parent in your list view.
112-
- **Collapsing/Expanding**:
113-
- Parents with children are marked with an indicator (`` for expanded, `` for collapsed).
114-
- Use **`Space`** on a parent task to toggle its expanded/collapsed state.
115-
- When a parent is collapsed, all its children are hidden, keeping your view focused.
116-
- **Hierarchy Visibility**: Tasks are automatically indented based on their nesting level, making it easy to visualize your project structure at a glance.
117-
- **Export/Import Preservation**: All export formats (JSON, CSV, Markdown, Text) now fully preserve your task hierarchy. Markdown and Text exports use structured indentation that is automatically recognized during import, ensuring your project structure remains intact across any format.
73+
## Features
11874

119-
### It's fast — genuinely fast
120-
Sub-millisecond fuzzy search. Full keyboard control. Vim bindings (`j/k/gg/G`). Natural language deadlines like `tomorrow 10am` or `next friday`. You never have to leave the keyboard.
75+
![Kairo Home Screen](screenshots/home_screen.png)
12176

122-
### Recurring tasks
123-
Tasks can automatically reappear based on a schedule. Weekly (e.g. `mon,wed,fri`) or Monthly (e.g. `15`). When a recurring task is completed, Kairo automatically generates the next instance with a smart due date preview in the editor, ensuring you never miss a beat.
77+
### ⚡ Genuinely Fast
78+
Sub-millisecond fuzzy search. Vim bindings (`j/k/gg/G`). Natural language deadlines like `tomorrow 10am` or `next friday`. Full keyboard control — you never touch the mouse.
12479

125-
### It respects your data
126-
SQLite storage with WAL mode. Fully offline. Optional Git-backed sync — no backend, no account, no lock-in. Export to JSON, CSV, Markdown, or plain text whenever you want.
80+
### 🗂 Nested Tasks & Hierarchy
81+
Organize work into deep hierarchies. Nest tasks via the **Parent** field in the editor, collapse/expand with `Space`, and export/import with full structure preserved — across JSON, CSV, Markdown, and plain text.
12782

128-
### It grows with you
129-
A Lua plugin system lets you hook into task events. A headless CLI API means you can automate anything. And an MCP server opens Kairo up to AI agents that can read and manage your tasks directly — now with full support for recurring schedules and nested hierarchies.
83+
### 🔁 Recurring Tasks
84+
Tasks reappear automatically on a schedule. Weekly (`mon,wed,fri`) or monthly (`15`). When completed, Kairo generates the next instance immediately with a smart due-date preview.
13085

131-
### AI — when you want it, invisible when you don't
132-
Optional Gemini integration (`gemini-3.1-flash-lite-preview` / `gemini-2.0-flash-lite` / `gemini-2.5-flash-lite`). Toggle it with `ctrl+a`. It never runs unless you invoke it. Now you can create and manage complex recurring tasks using simple natural language prompts. Your workflow, your call.
86+
### 🔒 Your Data, Locally
87+
SQLite with WAL mode. Fully offline. Optional Git-backed sync — no backend, no account, no lock-in. Export to JSON, CSV, Markdown, or plain text on demand.
13388

134-
### Beautiful by default
135-
32 built-in themes. Live switching with `t`. Bento-style layout. Real-time Markdown preview (`ctrl+p`). Cinematic animations for create, complete, and delete.
89+
### 🤖 AI — Optional, Never Intrusive
90+
Gemini integration (`gemini-2.5-flash-lite` / `gemini-2.0-flash-lite`). Toggle with `ctrl+a`. Create and manage complex recurring tasks with natural language. Invisible until you need it.
13691

137-
Each theme features a complete color palette that fills your entire terminal window with a seamless, edge-to-edge background — no gaps, no terminal defaults bleeding through. Whether you're in fullscreen mode or a resized window, the themed background covers the entire viewport consistently. All colors are fully reset to your terminal's default when Kairo exits.
92+
### 🎨 Beautiful by Default
93+
32 built-in themes with edge-to-edge background coverage. Live switching with `t`. Bento-style layout. Real-time Markdown preview (`ctrl+p`). Cinematic create/complete/delete animations — or disable them entirely in `config.toml`.
13894

139-
**Note:** Animations can be fully disabled in `config.toml` (`animations = false`) or the Settings TUI.
95+
### 🧩 Extensible to the Core
96+
A Lua plugin system hooks into task events. A headless CLI API enables full scripting. An MCP server opens Kairo to AI agents — with complete support for recurring schedules and nested hierarchies.
14097

14198
---
14299

143-
## ⌨️ The shortcuts that matter
100+
## Keyboard Shortcuts
144101

145-
| Key | What it does |
102+
| Key | Action |
146103
|---|---|
147104
| `n` | New task |
148-
| `Space` | Toggle collapse/expand |
149-
| `e` | Edit |
150-
| `z` | Complete |
151-
| `d` | Delete |
152-
| `t` | Switch theme |
105+
| `e` | Edit task |
106+
| `z` | Complete task |
107+
| `d` | Delete task |
108+
| `Space` | Collapse / expand subtasks |
153109
| `f` | Filter by tag |
154-
| `ctrl+p` | Command palette / Preview |
155-
| `ctrl+a` | AI panel | Hidden if API key is missing |
156-
| `?` | Help | |
157-
| `ctrl+s` | Settings | |
158-
| `x` | Import/Export | |
159-
| `ctrl+d` | Welcome tour | |
160-
161-
<div style="display: flex; gap: 10px;">
110+
| `t` | Switch theme |
111+
| `ctrl+p` | Command palette / Markdown preview |
112+
| `ctrl+a` | AI panel |
113+
| `ctrl+s` | Settings |
114+
| `x` | Import / Export |
115+
| `?` | Help |
116+
| `ctrl+d` | Welcome tour |
117+
118+
<div align="center">
119+
<img src="screenshots/filter_tags.png" width="30%" />
162120
<img src="screenshots/help_menu.png" width="30%" />
163121
<img src="screenshots/settings_menu.png" width="30%" />
122+
</div>
123+
124+
<div align="center">
164125
<img src="screenshots/theme_menu.png" width="30%" />
165126
</div>
166127

167128
---
168129

169-
## 🚀 Automate everything
130+
## CLI Automation
170131

171-
Kairo has a full CLI API for scripting and pipelines. It fully supports `parent_id` and `collapsed` state for automation:
132+
Kairo exposes a full CLI API for scripting and CI pipelines, with complete support for `parent_id` and `collapsed` state:
172133

173134
```bash
174-
# Create a task from anywhere
135+
# Create a task
175136
kairo api create --title "Finish report" --priority 1
176137

177-
# List tasks by tag
138+
# List by tag
178139
kairo api list --tag work
179140

180-
# Mark done
141+
# Mark complete
181142
kairo api update --id <id> --status done
182143

183-
# Export your whole list
144+
# Export everything
184145
kairo export --format markdown
185146
```
186147

187148
---
188149

189-
## 🧩 Extend it with Lua
150+
## Lua Plugin System
190151

191152
```lua
192153
local plugin = {
@@ -202,34 +163,35 @@ end)
202163
return plugin
203164
```
204165

205-
**Find sample plugins [here](https://github.com/programmersd21/kairo/tree/main/plugins).**
166+
Browse [sample plugins ](https://github.com/programmersd21/kairo/tree/main/plugins)
206167

207168
---
208169

209-
## 🧱 How it's built
170+
## Architecture
210171

211172
```
212-
Your input (CLI / TUI / Lua / AI)
213-
214-
Task Service (single source of truth)
215-
216-
SQLite (WAL) + optional Git sync
217-
218-
Bubble Tea TUI (instant rendering)
173+
Input (CLI · TUI · Lua · AI)
174+
175+
Task Service (single source of truth)
176+
177+
SQLite (WAL) + optional Git sync
178+
179+
Bubble Tea TUI (instant rendering)
219180
```
220181

221182
**Stack:** Bubble Tea · Lip Gloss · SQLite (WAL) · GopherLua · Gemini API · Git
222183

223184
---
224185

225-
## Everything included
186+
## Everything Included
226187

227188
| Feature | Status |
228189
|---|---|
229190
| Local-first SQLite storage ||
230-
| Folders & Nested Tasks ||
231-
| Full TUI with 32 themes ||
191+
| Nested tasks & folders ||
192+
| 32 themes, live switching ||
232193
| Keyboard-only workflow ||
194+
| Recurring tasks ||
233195
| Git sync (no backend) ||
234196
| Lua plugin system ||
235197
| CLI automation API ||
@@ -239,9 +201,9 @@ Your input (CLI / TUI / Lua / AI)
239201

240202
---
241203

242-
## ⚙️ Configuration
204+
## Configuration
243205

244-
Auto-generated on first run:
206+
Auto-generated on first run at:
245207

246208
- **Linux:** `~/.config/kairo/config.toml`
247209
- **macOS:** `~/Library/Application Support/kairo/config.toml`
@@ -250,17 +212,17 @@ Auto-generated on first run:
250212
| Option | Description | Default |
251213
|---|---|---|
252214
| `theme` | UI theme name | `catppuccin` |
253-
| `vim_mode` | Enable Vim keybindings | `false` |
254-
| `show_help` | Show help footer | `true` |
255-
| `show_id` | Show task IDs in detail view | `true` |
256-
| `animations` | Enable UI animations | `true` |
215+
| `vim_mode` | Vim keybindings | `false` |
216+
| `show_help` | Help footer | `true` |
217+
| `show_id` | Task IDs in detail view | `true` |
218+
| `animations` | UI animations | `true` |
257219
| `rainbow` | Animated rainbow logo | `false` |
258220

259-
Prefer in-app settings? `ctrl+s` opens the settings menu.
221+
Prefer not to edit files? `ctrl+s` opens the in-app settings menu.
260222

261223
---
262224

263-
## 🗺 What's coming
225+
## Roadmap
264226

265227
- Encrypted multi-workspace support
266228
- Event-sourced sync engine
@@ -271,22 +233,32 @@ Prefer in-app settings? `ctrl+s` opens the settings menu.
271233

272234
---
273235

274-
## 🤝 Contributing
275-
276-
If something bugs you, fix it. PRs are welcome — especially for themes, plugins, performance, and docs.
236+
## Star History
277237

278-
A huge thank you to [@Tornado300](https://github.com/Tornado300) for key bug fixes and contributions that made Kairo better for everyone.
238+
<a href="https://www.star-history.com/?repos=programmersd21%2Fkairo&type=date&legend=top-left">
239+
<picture>
240+
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/chart?repos=programmersd21/kairo&type=date&theme=dark&legend=top-left" />
241+
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/chart?repos=programmersd21/kairo&type=date&legend=top-left" />
242+
<img alt="Star History Chart" src="https://api.star-history.com/chart?repos=programmersd21/kairo&type=date&legend=top-left" />
243+
</picture>
244+
</a>
279245

280246
---
281247

282-
## ⭐ If Kairo helps you
248+
## Contributing
283249

284-
Star the repo. It's the simplest way to help other developers find this tool and spend less time fighting their workflow.
250+
PRs are welcome — especially for themes, plugins, performance, and docs. If something bugs you, fix it.
251+
252+
Huge thanks to [@Tornado300](https://github.com/Tornado300) for key bug fixes that made Kairo better for everyone.
285253

286254
---
287255

288256
<div align="center">
289257

258+
**If Kairo saves you time, a ⭐ helps other developers find it.**
259+
260+
<br/>
261+
290262
*Built for the terminal. Built for focus. Built for you.*
291263

292264
</div>

screenshots/logo.png

5.09 KB
Loading

0 commit comments

Comments
 (0)