Skip to content

Commit eb68b1d

Browse files
committed
docs: add status bar details to the readme
1 parent 88f9002 commit eb68b1d

2 files changed

Lines changed: 9 additions & 0 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,15 @@ If you have frequently used entry names you can define them in your template by
102102

103103
This will create an entry that is not yet started; you can start it by clicking the play button without having to type out the name.
104104

105+
## 👀 Status Bar Icons
106+
107+
Timekeep will show running timers in the Obsidian status bar, allowing you to see whats happening at a glance, you can then quickly open the file or stop the timer
108+
right from the status bar.
109+
110+
![Status Bar](images/status_bar.png)
111+
112+
*Status bar icons are only available if the registry setting is enabled as well as the status bar setting
113+
105114
## 🦾 API
106115

107116
Timekeep exposes a JS API which can be used by other scripts such as with [Dataview](https://blacksmithgu.github.io/obsidian-dataview/api/intro/)

images/status_bar.png

7.47 KB
Loading

0 commit comments

Comments
 (0)