obsidian-plugin/jacobtread_obsidian-timekeep
1
0
Fork 0
mirror of https://github.com/jacobtread/obsidian-timekeep.git synced 2026-07-22 10:10:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: readme corrections and license section

Browse source
This commit is contained in:
Jacobtread 2024-05-03 19:06:41 +12:00
parent 3f3a02f9f3
commit 3a648874e4
1 changed files with 15 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -6,13 +6,12 @@
![Build](https://img.shields.io/github/actions/workflow/status/jacobtread/obsidian-timekeep/build.yml?style=for-the-badge)
![Tests](https://img.shields.io/github/actions/workflow/status/jacobtread/obsidian-timekeep/tests.yml?style=for-the-badge&label=Tests)
This plugin provides a simple and easy way track time spent on various tasks. After tracking your time, you can export the tracked time as a **Markdown Table**, **CSV**, **JSON**, or **PDF**.
This plugin provides a way to simply and easily track time spent on various tasks. After tracking your time you can export the tracked time as a **Markdown Table**, **CSV**, **JSON**, or **PDF**
![Tracker](images/tracker.png)
This plugin provides a command for inserting time trackers `Timekeep: Insert Tracker` alternatively a timekeep can be created by creating a codeblock like the following:
This plugin provides a command for inserting time trackers: `Timekeep: Insert Tracker`. Alternatively, a timekeep can be created by creating a codeblock like the following:
````
```timekeep
@ -22,15 +21,15 @@ This plugin provides a command for inserting time trackers `Timekeep: Insert Tra
## Editing & Deleting
If you accidentally gave a block an incorrect name or started the timer late you can use the editing feature to update the stored data or delete the entry
If you accidentally gave a block an incorrect name or started the timer late, you can use the editing feature to update the stored data or delete the entry.
![Editing](images/editing.png)
## 👀 How its stored
This plugin is heavily inspired by [ObsidianSimpleTimeTracker](https://github.com/Ellpeck/ObsidianSimpleTimeTracker) (Semi backwards compatible some simple-time-tracker blocks can be renamed to timekeep) so the data for time tracking is stored as JSON within the `timekeep` codeblock.
This plugin is heavily inspired by [ObsidianSimpleTimeTracker](https://github.com/Ellpeck/ObsidianSimpleTimeTracker) (semi backwards compatible; some simple-time-tracker blocks can be renamed to timekeep), so the data for time tracking is stored as JSON within the `timekeep` code block.
The time block start and stop times are stored as timestamps, this makes it possible for you to start your time tracker then close Obsidian and have the tracking still continuing when you open it again.
The time block start and stop times are stored as timestamps, making it possible for you to start your time tracker, then close Obsidian and have the tracking continue when you open it again.
Below is an example of how this is stored:
@ -39,9 +38,9 @@ Below is an example of how this is stored:
```
## Formats
## Export Formats
Below are the various formats that timekeeping data can be exported to
Below are the various formats that timekeeping data can be exported to:
### Markdown Table
@ -61,13 +60,15 @@ Below are the various formats that timekeeping data can be exported to
### CSV
In the plugin settings you can choose to omit the first line of the CSV containing the column names
```csv
Block,Start time,End time,Duration
Example Time Block,24-03-17 19:32:36,24-03-17 19:32:37,0s
```
> [!NOTE]
> In the plugin settings, you can choose to omit the first line of the CSV containing the column names:
### JSON
The JSON export format simply copies the JSON stored inside the timekeep:
@ -78,7 +79,10 @@ The JSON export format simply copies the JSON stored inside the timekeep:
### Generated PDFs
Below is an example of a **PDF** generated by **Timekeep**. These **PDF**s are generated using react-pdf locally
Below is an example of a PDF generated by Timekeep. These PDFs are generated using react-pdf locally.
![Generated PDF](images/pdf.png)
## License
This project is licensed under the [MIT License](./LICENSE.md)