add readme, update manifest

2026-06-16 21:17:22 -07:00
parent 45299ff69e
commit ebcabf78d2
3 changed files with 14 additions and 3 deletions
@@ -0,0 +1,11 @@
+# About
+![Example screenshot](./demo.png)
+
+This plugin tries to emulate emacs's org-mode TODO list. It shows all of the tasks in your vault organized by tag. Tasks can be searched by their tag or by their content. 
+
+My workflow prior to vibecoding this plugin was to create tasks annotated with tags in daily notes, then create task lists using dataview for each tag in a separate note. I recalled having access to a global TODO list w/ filtering capabilities in emacs, so I decided to emulate it (at least what I remembered) in Obsidian.
+
+This plugin is extremely minimal and was COMPLETELY vibe-coded, so **USE AT YOUR OWN RISK**. Any updates to this plugin will be sporadic.
+
+## Install
+Create a folder inside `[your-vault]/.obsidian/plugins/` called `org-mode-todo` and copy `main.js` and `manifest.json` into that folder. Enable the plugin in Obsidian.