1 files changed, 7 insertions, 0 deletions

diff --git a/users/ryan/modules/taskwarrior-ubersicht/taskwarrior-widget-source/README.md b/users/ryan/modules/taskwarrior-ubersicht/taskwarrior-widget-source/README.md
new file mode 100755
index 0000000..bf20fb7
--- /dev/null
+++ b/users/ryan/modules/taskwarrior-ubersicht/taskwarrior-widget-source/README.md
@@ -0,0 +1,7 @@
+# Taskwarrior widget for Übersicht
+
+Inspired by the original Taskwarrior Widget by Kevin Bockelandt (<https://github.com/KevinBockelandt/TaskwarriorWidget>), but enhanced and rewritten from scratch for Übersicht’s more recent React + JSX framework.
+
+The widget displays a configurable number (default 20) of ready Taskwarrior tasks (i.e., those that have the `READY` virtual tag), sorted in descending order of urgency. The columns displayed are task ID, number of days/weeks/months/years (as appropriate) to due date, description, project, tags, urgency, and a configurable indicator (default 🟊) of whether you’ve started a task.
+
+Due and overdue tasks are highlighted using configurable colours.