From ad7bd8fd51cb93426309f461812b49e288f2ce87 Mon Sep 17 00:00:00 2001
From: Aly Raffauf <aly@aly.codes>
Date: Wed, 11 Feb 2026 08:31:59 -0500
Subject: [PATCH] Revise README: Add Quick Start and Features

---
 README.md | 62 ++++++++++++++++++++++++++++++++++++-------------------
 1 file changed, 41 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index 26974fd..37d4d50 100644
--- a/README.md
+++ b/README.md
@@ -1,44 +1,64 @@
+<div align="center">
+
 # dewy
 
-A TUI for Todoist built with Ink + React.js + Typescript.
+A fast, minimal TUI for Todoist built with React.js + Ink + Typescript.
+
+</div>
+
+## Features
+
+- **Filter views** — browse tasks by Todoist filter queries like `today`, `overdue`, or custom filters
+- **Project views** — jump to any project by name
+- **Quick add** — add tasks using Todoist's quick add syntax (dates, labels, projects all work)
+- **Smart hints** — command suggestions appear as you type
+- **XDG config** — simple JSON config at `~/.config/dewy/config.json`
 
 ## Install
 
 ```bash
-$ npm install --global dewy
+npm install --global dewy
 ```
 
-## Usage
+## Quick Start
 
-```
-$ dewy
-```
-
-## Configuration
+1. Grab your API token from [Todoist settings](https://todoist.com/app/settings/integrations/developer)
 
-dewy uses a config file at `~/.config/dewy/config.json`:
+2. Create your config file:
 
-```json
+```bash
+mkdir -p ~/.config/dewy
+cat > ~/.config/dewy/config.json << 'EOF'
 {
-	"apiToken": "your-todoist-api-token",
-	"homeFilter": "(today | overdue) & (assigned to: me | !assigned)"
+	"apiToken": "your-token-here"
 }
+EOF
 ```
 
+3. Run it:
+
+```bash
+dewy
+```
+
+## Configuration
+
 | Key | Type | Required | Description |
 |-----|------|----------|-------------|
-| `apiToken` | string | yes | Your Todoist API token |
-| `homeFilter` | string | no | Custom Todoist filter to apply on the home view |
+| `apiToken` | `string` | yes | Your Todoist API token |
+| `homeFilter` | `string` | no | Todoist filter for the home view (default: `today`) |
 
 ## Commands
 
-- `add <text>` - Add a new task via Todoist's QuickAdd
-- `done <number>` - Complete a task by its number
-- `refresh` - Reload tasks
-- `project <name>` - View tasks in a project
-- `today` - View today's tasks
-- `home` - View the home filter
-- `quit` - Exit
+| Command | Description |
+|---------|-------------|
+| `add <task>` | Add a task via quick add |
+| `done <number>` | Complete a task by its number |
+| `project <name>` | View tasks in a project |
+| `today` | View today's tasks |
+| `home` | View the home filter |
+| `refresh` | Reload tasks |
+| `quit` | Exit |
 
 ## License
 
-- 
2.51.2