commit faf285a4934a1cd301312acdd97d1c3c7891ad52
parent 11dfcba5d992e330f88e718dd29f4759d1c05373
Author: Hunter
Date: Wed, 7 Oct 2026 21:59:35 -0400
add readme images
Diffstat:
8 files changed, 37 insertions(+), 13 deletions(-)
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
tests/
+readme-gifs/
diff --git a/readme.md b/readme.md
@@ -1,10 +1,12 @@
# 🪆 matryoshka
-<a href="https://hunterirving.github.io/matryoshka/"><img src="resources/images/screenshot.gif" width="700px"></a><br>
-
turn mountains into molehills (then molehills into anthills) with <b>matryoshka</b>,<br>
the nested todo list that breaks complex tasks into manageable subtasks.
+<p align="center">
+ <a href="https://hunterirving.github.io/matryoshka/"><img src="resources/images/screenshot.gif" width="400px"></a>
+</p>
+
<i><b>try it now <a href="https://hunterirving.github.io/matryoshka/">in your browser</a>!</b></i> (physical keyboard required).
### key features
@@ -16,22 +18,31 @@ the nested todo list that breaks complex tasks into manageable subtasks.
### quickstart
1. press the `Return` / `Enter` key to add subtasks to the root "todo" task
2. give each new subtask a meaningful name
-3. use `Shift + ➡️` to navigate into a subtask
-4. use `Shift + ⬅️` to return to the enclosing parent task
+3. use `Shift + ➡︎` to navigate into a subtask
+4. use `Shift + ⬅︎` to return to the enclosing parent task
5. use `Shift + Enter` to quickly mark tasks as complete or incomplete
## controls
### navigation
-- `⬆️/⬇️` move between tasks at the same level
-- `Shift + ➡️` navigate into a subtask
-- `Shift + ⬅️` return to the enclosing parent task
+- `⬆︎/⬇︎` move between tasks at the same level
+- `Shift + ➡︎` navigate into a subtask
+- `Shift + ⬅︎` return to the enclosing parent task
+
+<p align="center">
+ <img src="resources/images/breakdown.gif" width="400px">
+</p>
### task management
- `Enter` add a new task
-- `⬇️` (on last subtask) add a new task at the bottom of the list
+- `⬇︎` (on last subtask) add a new task at the bottom of the list
- `Backspace` (when task text is empty) delete selected task(s) and their subtasks
- `Shift + Enter` toggle selected task(s) completion status
+
+<p align="center">
+ <img src="resources/images/complete.gif" width="400px">
+</p>
+
- `⌘ + C` copy selected task(s) and their subtasks
- `⌘ + X` cut selected task(s) and their subtasks
- `⌘ + V` paste copied task(s) and their subtasks
@@ -39,18 +50,30 @@ the nested todo list that breaks complex tasks into manageable subtasks.
- `⌘ + Shift + Z` redo
### reorganization
-- `Shift + ⬆️/⬇️` reposition selected task(s) within their current level
-- `⌘ + ⬆️/⬇️` push selected task(s) into the task above or below
-- `⌘ + ⬅️` pull selected task(s) out one level (to the level of their parent)
+- `Shift + ⬆︎/⬇︎` reposition selected task(s) within their current level
+- `⌘ + ⬆︎/⬇︎` push selected task(s) into the task above or below
+- `⌘ + ⬅︎` pull selected task(s) out one level (to the level of their parent)
- hold `Shift` with any `⌘` command (push/pull) to simultaneously navigate to the task(s)' new position
+<p align="center">
+ <img src="resources/images/reorganize.gif" width="400px">
+</p>
+
### multi-select
-- `Option + ⬆️/⬇️` extend or contract the selection to include adjacent tasks
-- `⬆️/⬇️` (without modifier) clear the selection and resume single-task navigation
+- `Option + ⬆︎/⬇︎` extend or contract the selection to include adjacent tasks
+- `⬆︎/⬇︎` (without modifier) clear the selection and resume single-task navigation
+
+<p align="center">
+ <img src="resources/images/multi_select.gif" width="400px">
+</p>
### theming
- press `F2` to cycle through available themes (`Shift + F2` to cycle in reverse)
+<p align="center">
+ <img src="resources/images/themes.gif" width="400px">
+</p>
+
## data persistence
your task tree is automatically saved to your browser's local storage after each edit. this ensures your tasks will persist even if you close the browser or refresh the page.
diff --git a/resources/images/breakdown.gif b/resources/images/breakdown.gif
Binary files differ.
diff --git a/resources/images/complete.gif b/resources/images/complete.gif
Binary files differ.
diff --git a/resources/images/multi_select.gif b/resources/images/multi_select.gif
Binary files differ.
diff --git a/resources/images/reorganize.gif b/resources/images/reorganize.gif
Binary files differ.
diff --git a/resources/images/screenshot.gif b/resources/images/screenshot.gif
Binary files differ.
diff --git a/resources/images/themes.gif b/resources/images/themes.gif
Binary files differ.
