From e0cb6086878da35f5a84637cd2f94379490d1258 Mon Sep 17 00:00:00 2001
From: Kris Yotam <75515498+krisyotam@users.noreply.github.com>
Date: Sun, 12 Apr 2026 11:20:52 -0500
Subject: [PATCH] add README.md

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..dd9a005e6390418df00dcd5c6341b5dc3f8f38ba
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# stask
+
+Simple task manager in the suckless tradition. Written in C with SQLite for storage and GTK4 for the optional GUI.
+
+Tasks are organized into named lists. Each list tracks total and completed items. The CLI works standalone; pass `-g` for the graphical interface.
+
+## Usage
+
+```
+stask [-g]              launch GUI / list all lists
+stask ls                list all lists
+stask new <list>        create a new list
+stask rm <list>         delete a list
+stask <list>            show tasks in a list
+stask <list> add "text" add a task
+stask <list> done <id>  mark task complete
+stask <list> undo <id>  unmark task
+stask <list> del <id>   delete a task
+stask <list> edit <id>  edit task text
+stask <list> show <id>  show task details
+```
+
+## Configuration
+
+Edit `config.h` to customize the GTK4 theme. Ships with a monochromatic palette (light and dark) matching krisyotam.com.
+
+## Requirements
+
+- C compiler
+- SQLite3
+- GTK4 (for GUI mode)
+
+## Installation
+
+Edit `config.mk` to match your local setup, then:
+
+```sh
+make clean install
+```