Skip to content

Commit

Permalink
Updates README and example markdown with nested items re #19
Browse files Browse the repository at this point in the history
  • Loading branch information
lynchjames committed Nov 11, 2020
1 parent 6baeaed commit b90e596
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 1 deletion.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ Within the note, you can create a check list with times and tasks which will be
- [ ] 15:00 Review notes and update daily note [[20201103]]
- [ ] 15:45 Walk
- [ ] 16:30 Reading
- [ ] Article 1
- [ ] Article 2
- Article notes review
- [ ] 17:20 Prep for tomorrow's meetings
- [ ] 18:00 END

Expand All @@ -45,6 +48,8 @@ The format of the task list items is important as this is what is used to calcul

**24 hour times should be used.**

Nested checklist items or bullets are now also supported to capture sub-tasks of a timed task. Timed tasks must be at the top level of the checkbox list.

`BREAK` and `END` are keywords that define breaks and the end to the time tracking for the tasks. They are not case sensitive so `break` and `end` can also be used.

`END` is used as an item with a time to give an accurate time interval for the last task, *"Prep for tomorrow's meetings"* at 17:00 in this example.
Expand Down Expand Up @@ -74,6 +79,9 @@ Using the example above, at 14:30 the note would have automatically updated to:
- [ ] 15:00 Review notes and update daily note [[20201103]]
- [ ] 15:45 Walk
- [ ] 16:30 Reading
- [ ] Article 1
- [ ] Article 2
- [ ] Article notes review
- [ ] 17:20 Prep for tomorrow's meetings
- [ ] 18:00 END

Expand Down
3 changes: 3 additions & 0 deletions examples/day-planner-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
- [ ] 10:30 Create new notes for #article review
- [ ] 11:30 BREAK
- [ ] 12:00 Reading
- [ ] Article 1
- [ ] Article 2
- [ ] Article notes review
- [ ] 12:25 BREAK
- [ ] 12:30 Reading
- [ ] 14:00 BREAK
Expand Down
2 changes: 1 addition & 1 deletion manifest.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"id": "obsidian-day-planner",
"name": "Day Planner",
"version": "0.3.2",
"version": "0.3.3",
"description": "A plugin to help you plan your day and setup pomodoro timers",
"isDesktopOnly": false,
"js": "main.js",
Expand Down

0 comments on commit b90e596

Please sign in to comment.