aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1b7142b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+# track
+Time tracker for nerds
+
+## Installation
+
+```
+go install github.com/neonxp/track@latest
+```
+
+OS specified packages will be soon
+
+## Usage
+
+1. Add new activity:
+```
+track add Activity summary [#tag1 #tag2 @context1 @context2]
+```
+example:
+```
+~ track add Work on time tracker #tracker @home
+Activity #1 added! Now you can start it.
+```
+2. Start activity:
+```
+track start ID [comment]
+```
+example:
+```
+~ track start 1 Writing documentation.
+Started new span for activity "Work on time tracker".
+```
+3. List activities:
+```
+track ls [--all]
+```
+example:
+```
+~ track ls
+Started activities:
+1. Work on time tracker
+ 1 timespans
+ 19:17 5.12.2021 — now (10 minutes)
+```
+4. Complete work on activity. if activity id empty - stop all started activities:
+```
+track stop [ID]
+```
+example:
+```
+~ track stop
+Stopped activity "Work on time tracker".
+Last duration: 12 minutes.
+All spent time: 12 minutes.
+```