jdb/ptk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added README and TODO.

Browse Source
This commit is contained in:
Jonathan Bernard 2016-10-11 13:29:31 -05:00
parent bf5c0a5752
commit 033862f793
2 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md Normal file
View File

@ -0,0 +1,14 @@
# Personal Time Keeper
`ptk` is a small utility to log time entries. It uses a simple conceptual model
and a simple JSON data format.
A ptk timeline is made up of a series of ptk entries, or marks. Each mark has a
summary, a timestamp, and a universally unique id (generated by `ptk`).
Additionally a mark may be tagged with an arbitrary number of tags and may have
detailed notes attached to it (anything representable in plain text).
The duration of a task is calculated by taking the difference between that
task's timestamp and the one following it chronologically. The `STOP` value as
a summary serves as a sentinal to indicate that an entry has been completed
and no new entry is being tracked.

3
TODO.md Normal file
View File

@ -0,0 +1,3 @@
* Allow the user to use the `-g` and `-G` flags to filter tasks to sum or list
by tags (currently only date and id ranges are supported).
* Sync with web timestamper.