From 36b5d7a6d7814019e3e7411312383db0b50cbec9 Mon Sep 17 00:00:00 2001 From: karl Date: Tue, 15 Dec 2020 21:57:46 +0100 Subject: [PATCH] Add proper README --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index f2f0124..7c7835c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,30 @@ # time.txt +Simple plain-text time tracking. + +The Python script `tx` provides short-hands for accessing and reading a `time.txt` file, as described below. + +## Usage + +Create a new `time.txt` file at the current location: `tx create` + +Add a time entry: `tx add 01:00 Totally productive work` + +View the total unbilled time: `tx total` or simply `tx` + +Remove time which was billed: `tx bill 05:00 Fee note for this month` + +## Format + +The `time.txt` file is written in the following format: + +``` +2020-08-12 01:00 Work on Task 1 +2020-08-12 03:00 Work on Task 2 +2020-08-16 05:00 Finish Task 2 +2020-08-31 -08:00 Fee note for August +``` + +With this file, the total amount of (unbilled) hours is 01:00. + +All `tx` commands are simply short-hands for accessing and reading this file comfortably. It can be edited manually at any time.