From daad3faddb9e9f6e64a9c62bdd50ca0c1f5aaf1a Mon Sep 17 00:00:00 2001
From: xeruf <27jf@pm.me>
Date: Thu, 25 Jul 2024 01:02:26 +0300
Subject: [PATCH] docs: functionality reference

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

diff --git a/README.md b/README.md
index 9433158..35c6f6e 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,47 @@ cargo run # Listen to events
 nostril --envelope --content "realtime message" --kind 90002 | websocat ws://localhost:4736 # Send a test event
 ```
 
+## Principles
+
+- active task is tracked automatically
+- progress through subdivision rather than guessing
+- TBI: show/hide closed/done tasks
+
+Recommendation: Flat hierarchy, using tags for filtering (TBI)
+
+## Reference
+
+TASK add syntax: `NAME: TAG1 TAG2`
+
+- `TASK` - create task
+- `.` - clear filters and reload
+- `.TASK` - filter / activate (by id or name) / create & activate task
+- `.NUM` - set view depth - how many subtask levels to show
+
+Dots can be repeated to move to parent tasks
+
+- `:[IND][COL]` - add / remove property column COL to IND or end
+- `>` - Complete active task and move to parent
+- `<` - Close active task and move to parent
+- TBI: `-TEXT` - add text note (comment / description)
+
+### Columns
+
+- `id`
+- `parentid`
+- `name`
+- `state`
+- `desc` - accumulated notes of the task
+- `path` - name including parent tasks
+- `rpath` - name including parent tasks up to active task
+- `time` - time tracked
+- `ttime` - time tracked including subtasks
+- TBI: `progress` - how many subtasks are complete
+
+For debugging: `props` - Task Property Events
+
 ## Plans
 
+- Expiry (no need to fetch potential years of history)
+- Web Interface, Messenger bots
 - TUI - Clear terminal?
\ No newline at end of file