From a37d0e9272b8dcb7c0640bb14de6f4105e609888 Mon Sep 17 00:00:00 2001
From: Marty Oehme <contact@martyoeh.me>
Date: Mon, 31 Mar 2025 18:57:42 +0200
Subject: [PATCH] Add README

Adds an in-progress readme
---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9a3e5a8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# Topen - super simple taskwarrior note editing
+
+A script without bells and whistles.
+Focuses on letting you quickly:
+
+- create notes for taskwarrior tasks
+- edit notes for taskwarrior tasks
+
+Does both by simply being invoked with `topen <task-id>`.
+
+Automatically appends a small 'Note' annotation to your task so you know you have notes.
+
+<!-- TODO: Implement configuration options -->
+Should just work as-is without additional configuration in most taskwarrior setups.
+But can be configured through environment variables or cli options, see below.
+
+Can be used as-is or directly from taskwarrior by being aliased:
+
+```conf
+alias.note=exec topen
+```
+
+And you can open any note with your usual taskwarrior workflow,
+by doing `task note <id>`.
+
+That's all there is to it.
+
+## Configuration
+
+<!-- TODO: Stub section -->
+
+`TOPEN_DIR`
+
+`TOPEN_EXT`
+
+`TASKRC`
+
+`TASK_DATA`
+
+`TOPEN_ANNOT`