From 033862f79373e3ed89c1a089c6f822c119cac17e Mon Sep 17 00:00:00 2001 From: Jonathan Bernard Date: Tue, 11 Oct 2016 13:29:31 -0500 Subject: [PATCH] Added README and TODO. --- README.md | 14 ++++++++++++++ TODO.md | 3 +++ 2 files changed, 17 insertions(+) create mode 100644 README.md create mode 100644 TODO.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..4230c8b --- /dev/null +++ b/README.md @@ -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. diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..48cfcd8 --- /dev/null +++ b/TODO.md @@ -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.