From ad41fe3fbf1f365746035e9673644a65ed5a442c Mon Sep 17 00:00:00 2001
From: xavi <xavi@xavishobbies.org>
Date: Sat, 7 Sep 2024 19:26:46 -0700
Subject: [PATCH] Modified README to include command descriptions

---
 README.md | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d93c06e..5a62f29 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,41 @@
 # dodo
 
-A kanban style task manager with task status descriptions.
\ No newline at end of file
+A kanban style task manager with task specific log entries.
+
+## commands
+
+##### `dodo` or `dodo view <project tag>`
+
+Displays kanban board of all tasks by default. If project name is specified only tasks tagged with project name will be displayed. Task sorted into three columns - today, backlog, and blocked.
+
+"The 'Today' column is for tasks that are actively being worked on. The 'Backlog' column is for tasks that haven't been started yet or are not currently being addressed. The 'Blocked' column is for tasks that cannot be worked on at the moment."
+
+All columns are sorted by due date first then creation date.
+
+Each task is prefixed with an **Active id** that can be used in lieu of a task name.
+
+
+##### `dodo new <task name> due:<task due date> project:<project tag>`
+Create new task. By default new task is added to the backlog.
+
+
+##### `dodo <today/backlog/blocked> <task name or active id>`
+Move task to specified column
+
+
+##### `dodo done <task name or active id>`
+Complete task and remove from active boards
+
+
+##### `dodo change <task name or active id> <changed task name> due:<changed or new due date> project:<changed or new project tag>`
+Alter specified task. Any of the changed properties can be omitted to default to unaltered.
+
+
+##### `dodo log <task name or active id>`
+Add log entry to specified task
+
+##### `dodo view_logs <task name or active id>`
+View specified task log entries
+
+##### `dodo delete <task name or active id>`
+Delete specified task from all boards and purge data