summaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
Diffstat (limited to 'README.org')
-rw-r--r--README.org9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..f817dd7
--- /dev/null
+++ b/README.org
@@ -0,0 +1,9 @@
+#+TITLE: org-urgency
+#+SUBTITLE: Smart, rules-based Org-agenda sorting
+
+* =org-urgency=
+/Smart, rules-based Org-agenda sorting./
+
+=org-urgency= provides a system for ranking tasks known as “urgency.” Note that the term “urgency” as used in this project is the same as [[https://taskwarrior.org/docs/urgency/][Taskwarrior’s]], not the same as Org Agenda’s. Please read the package’s description and function docstrings to learn how to use it.
+
+*Warning: This project is still version < 1.0, and is therefore /not guaranteed to be stable/. I maintain it for myself, but do not have capacity to improve or test it beyond my needs.* If you find a bug, feel free to report it, but don’t expect there not to be any.