diff --git a/README.md b/README.md new file mode 100644 index 0000000..cab4e1e --- /dev/null +++ b/README.md @@ -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. diff --git a/demo.png b/demo.png new file mode 100644 index 0000000..569791f Binary files /dev/null and b/demo.png differ diff --git a/manifest.json b/manifest.json index 0540f37..3b9608c 100644 --- a/manifest.json +++ b/manifest.json @@ -3,7 +3,7 @@ "name": "Org TODO List", "version": "0.1.0", "minAppVersion": "1.4.0", - "description": "An org-agenda-style TODO buffer with live filtering. Scans the vault for checkbox tasks, tagged with @, and lets you narrow the list as you type.", - "author": "you", - "isDesktopOnly": false + "description": "An org-agenda-style TODO buffer with live filtering. Scans the vault for checkbox tasks, tagged with #, and lets you narrow the list as you type.", + "author": "Rostyslav Hnatyshyn (rostyslav.hnatyshyn@gmail.com)", + "isDesktopOnly": true }